Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
OTAbitmap.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 OTABITMAP_H
58 #define OTABITMAP_H
59 
60 /* OTA Bitmap - used for CLI Icon and Operator logo messages
61  *
62  * Kalle Marjola 1999 for WapIT Ltd.
63  *
64  * functions to store OTA Bitmaps and and create Octet strings from them
65  */
66 
67 #include "gwlib/gwlib.h"
68 
69 /* OTA Bitmap
70  */
71 typedef struct OTA_bitmap {
75  int width; /* 8 or 16 bits, defined by infofield */
76  int height; /* ditto */
77  int depth;
80  int animimg_count; /* total # of animated images */
81  /* Octet *palette; */
82 } OTAbitmap;
83 
84 /* create a new empty OTAbitmap struct. Return a pointer to it or NULL if
85  * operation fails
86  */
88 
89 
90 /* delete given OTAbitmap, including freeing the pixmap */
91 void OTAbitmap_delete(OTAbitmap *pic);
92 
93 
94 #define NEGATIVE 1 /* source has white=0, black=1 */
95 #define REVERSE 2 /* source has righmost as most significant */
96 
97 /* create a new bitmap
98  *
99  * width and height are size of the bitmap,
100  * data is the entire bitmap; from left-top corner to righ-bottom;
101  * if the width is not dividable by 8, the rest of the row is NOT padded
102  * with zeros. bytes are ordered big-endian
103  *
104  * target: black=0, white=1, most significant leftmost
105  *
106  * You can generate raw bitmap in Linux (RH 6.0) with following line:
107  * %> convert -monochrome input_file target.mono
108  *
109  * ..which then requires flags REVERSE and NEGATIVE
110  *
111  * return pointer to created OTAbitmap, or NULL if fails
112  */
113 OTAbitmap *OTAbitmap_create(int width, int height, int depth, Octet *data, int flags);
114 
115 /* create Octet stream out of given OTAbitmap
116  * return the length of stream, *stream is set to new stream which must
117  * be freed by the caller
118  */
119 int OTAbitmap_create_stream(OTAbitmap *pic, Octet **stream);
120 
121 
122 #endif
Octet * ext_fields
Definition: OTAbitmap.h:73
struct OTA_bitmap OTAbitmap
int animimg_count
Definition: OTAbitmap.h:80
int height
Definition: OTAbitmap.h:76
int depth
Definition: OTAbitmap.h:77
OTAbitmap * OTAbitmap_create(int width, int height, int depth, Octet *data, int flags)
Definition: OTAbitmap.c:91
int OTAbitmap_create_stream(OTAbitmap *pic, Octet **stream)
Definition: OTAbitmap.c:137
Octet * main_image
Definition: OTAbitmap.h:78
Octet infofield
Definition: OTAbitmap.h:72
int width
Definition: OTAbitmap.h:75
int extfield_count
Definition: OTAbitmap.h:74
void OTAbitmap_delete(OTAbitmap *pic)
Definition: OTAbitmap.c:78
OTAbitmap * OTAbitmap_create_empty(void)
Definition: OTAbitmap.c:69
unsigned char Octet
Definition: utils.h:75
Octet ** animated_image
Definition: OTAbitmap.h:79
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.