Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
wbmp.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 #ifndef WBMP_H
58 #define WBMP_H
59 
60 /* WBMP - Wireless Bitmap
61  *
62  * Kalle Marjola 1999 for WapIT Ltd.
63  *
64  * functions to store WBMPs and and create Octet strings from them
65  */
66 
67 #include "gwlib/gwlib.h"
68 
69 
70 /* extension header parameters... not implemented/supported in any WBMP
71  * yet... but for future reference, although I'm quite sure there is
72  * something wrong in these...
73  */
74 typedef struct extparam {
75  Octet bitfield; /* if bitfield additional data */
76  /* or */
77  char param[9]; /* parameter */
78  char value[17]; /* and associated value */
79 } ExtParam;
80 
81 /* WBMP - wireless bitmap format
82  *
83  * structure to define wireless bitmap - not complete!
84  */
85 typedef struct wbmp {
88  /* extension header is a bit more complicated thing that what is
89  * represented here but the spesification is a bit obfuscated one
90  * and they are not yet used to anything, so it is left undefined
91  */
93  int exthdr_count; /* total # of ext headers */
98  int animimg_count; /* total # of animated images */
99 } WBMP;
100 
101 /* create a new empty WBMP struct. Return a pointer to it or NULL if
102  * operation fails
103  */
104 WBMP *wbmp_create_empty(void);
105 
106 
107 /* delete given WBMP, including freeing the pixmap */
108 void wbmp_delete(WBMP *pic);
109 
110 
111 #define NEGATIVE 1 /* source has white=0, black=1 */
112 #define REVERSE 2 /* source has righmost as most significant */
113 
114 /* create a new bitmap
115  *
116  * type: 0 (B/W, Uncompressed bitmap) WBMP - the only type currently
117  * specificated.
118  *
119  * width and height are size of the bitmap,
120  * data is the entire bitmap; from left-top corner to righ-bottom;
121  * if the width is not dividable by 8, the rest of the row is padded with
122  * zeros. bytes are ordered big-endian
123  *
124  * target: black=0, white=1, most significant leftmost
125  *
126  * You can generate raw bitmap in Linux (RH 6.0) with following line:
127  * %> convert -monochrome input_file target.mono
128  *
129  * ..which then requires flags REVERSE and NEGATIVE
130  *
131  * return pointer to created WBMP, or NULL if fails
132  */
133 WBMP *wbmp_create(int type, int width, int height, Octet *data, int flags);
134 
135 /* create Octet stream out of given WBMP
136  * return the length of stream, *stream is set to new stream which must
137  * be freed by the caller
138  */
139 int wbmp_create_stream(WBMP *pic, Octet **stream);
140 
141 
142 #endif
char value[17]
Definition: wbmp.h:78
struct extparam ExtParam
MultibyteInt height
Definition: wbmp.h:95
Octet * main_image
Definition: wbmp.h:96
ExtParam * ext_header_field
Definition: wbmp.h:92
void wbmp_delete(WBMP *pic)
Definition: wbmp.c:80
int type
Definition: smsc_cimd2.c:215
int wbmp_create_stream(WBMP *pic, Octet **stream)
Definition: wbmp.c:127
struct wbmp WBMP
Octet bitfield
Definition: wbmp.h:75
unsigned long MultibyteInt
Definition: utils.h:76
char param[9]
Definition: wbmp.h:77
Definition: wbmp.h:74
MultibyteInt width
Definition: wbmp.h:94
WBMP * wbmp_create(int type, int width, int height, Octet *data, int flags)
Definition: wbmp.c:94
WBMP * wbmp_create_empty(void)
Definition: wbmp.c:69
Definition: wbmp.h:85
Octet fix_header_field
Definition: wbmp.h:87
MultibyteInt type_field
Definition: wbmp.h:86
int exthdr_count
Definition: wbmp.h:93
int animimg_count
Definition: wbmp.h:98
unsigned char Octet
Definition: utils.h:75
Octet ** animated_image
Definition: wbmp.h:97
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.