iPXE
pixbuf.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2013 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 /** @file
27  *
28  * Pixel buffer
29  *
30  */
31 
32 #include <stdlib.h>
33 #include <errno.h>
34 #include <ipxe/umalloc.h>
35 #include <ipxe/image.h>
36 #include <ipxe/pixbuf.h>
37 
38 /**
39  * Free pixel buffer
40  *
41  * @v refcnt Reference count
42  */
43 static void free_pixbuf ( struct refcnt *refcnt ) {
44  struct pixel_buffer *pixbuf =
46 
47  ufree ( pixbuf->data );
48  free ( pixbuf );
49 }
50 
51 /**
52  * Allocate pixel buffer
53  *
54  * @v width Width
55  * @h height Height
56  * @ret pixbuf Pixel buffer, or NULL on failure
57  */
58 struct pixel_buffer * alloc_pixbuf ( unsigned int width, unsigned int height ) {
59  struct pixel_buffer *pixbuf;
60 
61  /* Allocate and initialise structure */
62  pixbuf = zalloc ( sizeof ( *pixbuf ) );
63  if ( ! pixbuf )
64  goto err_alloc_pixbuf;
65  ref_init ( &pixbuf->refcnt, free_pixbuf );
66  pixbuf->width = width;
67  pixbuf->height = height;
68  pixbuf->len = ( width * height * sizeof ( uint32_t ) );
69 
70  /* Check for multiplication overflow */
71  if ( ( width != 0 ) &&
72  ( ( pixbuf->len / sizeof ( uint32_t ) ) / width ) != height ) {
73  goto err_overflow;
74  }
75 
76  /* Allocate pixel data buffer */
77  pixbuf->data = umalloc ( pixbuf->len );
78  if ( ! pixbuf->data )
79  goto err_alloc_data;
80 
81  return pixbuf;
82 
83  err_alloc_data:
84  err_overflow:
85  pixbuf_put ( pixbuf );
86  err_alloc_pixbuf:
87  return NULL;
88 }
89 
90 /**
91  * Create pixel buffer from image
92  *
93  * @v image Image
94  * @v pixbuf Pixel buffer to fill in
95  * @ret rc Return status code
96  */
97 int image_pixbuf ( struct image *image, struct pixel_buffer **pixbuf ) {
98  int rc;
99 
100  /* Check that this image can be used to create a pixel buffer */
101  if ( ! ( image->type && image->type->pixbuf ) )
102  return -ENOTSUP;
103 
104  /* Try creating pixel buffer */
105  if ( ( rc = image->type->pixbuf ( image, pixbuf ) ) != 0 ) {
106  DBGC ( image, "IMAGE %s could not create pixel buffer: %s\n",
107  image->name, strerror ( rc ) );
108  return rc;
109  }
110 
111  return 0;
112 }
113 
114 /* Drag in objects via image_pixbuf() */
116 
117 /* Drag in pixel buffer image formats */
118 REQUIRE_OBJECT ( config_pixbuf );
int image_pixbuf(struct image *image, struct pixel_buffer **pixbuf)
Create pixel buffer from image.
Definition: pixbuf.c:97
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
struct pixel_buffer * alloc_pixbuf(unsigned int width, unsigned int height)
Allocate pixel buffer.
Definition: pixbuf.c:58
static void free_pixbuf(struct refcnt *refcnt)
Free pixel buffer.
Definition: pixbuf.c:43
#define ref_init(refcnt, free)
Initialise a reference counter.
Definition: refcnt.h:64
Error codes.
unsigned int height
Height.
Definition: pixbuf.h:23
struct image_type * type
Image type, if known.
Definition: image.h:46
#define DBGC(...)
Definition: compiler.h:505
An executable image.
Definition: image.h:24
Pixel buffer.
#define ENOTSUP
Operation not supported.
Definition: errno.h:589
A reference counter.
Definition: refcnt.h:26
size_t len
Total length.
Definition: pixbuf.h:27
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
Executable images.
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
A pixel buffer.
Definition: pixbuf.h:17
User memory allocation.
struct refcnt refcnt
Reference count.
Definition: pixbuf.h:19
unsigned int uint32_t
Definition: stdint.h:12
static __always_inline void ufree(userptr_t userptr)
Free external memory.
Definition: umalloc.h:65
static __always_inline userptr_t umalloc(size_t size)
Allocate external memory.
Definition: umalloc.h:54
int(* pixbuf)(struct image *image, struct pixel_buffer **pixbuf)
Create pixel buffer from image.
Definition: image.h:102
REQUIRING_SYMBOL(image_pixbuf)
userptr_t data
32-bit (8:8:8:8) xRGB pixel data, in host-endian order
Definition: pixbuf.h:25
char * name
Name.
Definition: image.h:34
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
unsigned int width
Width.
Definition: pixbuf.h:21
REQUIRE_OBJECT(config_pixbuf)