iPXE
pixbuf.c File Reference

Pixel buffer. More...

#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <ipxe/umalloc.h>
#include <ipxe/image.h>
#include <ipxe/pixbuf.h>

Go to the source code of this file.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 FILE_SECBOOT (PERMITTED)
static void free_pixbuf (struct refcnt *refcnt)
 Free pixel buffer.
struct pixel_bufferalloc_pixbuf (unsigned int width, unsigned int height)
 Allocate pixel buffer.
int image_pixbuf (struct image *image, struct pixel_buffer **pixbuf)
 Create pixel buffer from image.
 REQUIRING_SYMBOL (image_pixbuf)
 REQUIRE_OBJECT (config_pixbuf)

Detailed Description

Pixel buffer.

Definition in file pixbuf.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ free_pixbuf()

void free_pixbuf ( struct refcnt * refcnt)
static

Free pixel buffer.

Parameters
refcntReference count

Definition at line 45 of file pixbuf.c.

45 {
46 struct pixel_buffer *pixbuf =
48
49 ufree ( pixbuf->data );
50 free ( pixbuf );
51}
static __always_inline void ufree(void *ptr)
Free external memory.
Definition umalloc.h:68
static void(* free)(struct refcnt *refcnt))
Definition refcnt.h:55
#define container_of(ptr, type, field)
Get containing structure.
Definition stddef.h:36
A pixel buffer.
Definition pixbuf.h:17
uint32_t * data
32-bit (8:8:8:8) xRGB pixel data, in host-endian order
Definition pixbuf.h:25
A reference counter.
Definition refcnt.h:27

References container_of, pixel_buffer::data, free, and ufree().

Referenced by alloc_pixbuf().

◆ alloc_pixbuf()

struct pixel_buffer * alloc_pixbuf ( unsigned int width,
unsigned int height )

Allocate pixel buffer.

Parameters
widthWidth @h height Height
Return values
pixbufPixel buffer, or NULL on failure

Definition at line 60 of file pixbuf.c.

60 {
61 struct pixel_buffer *pixbuf;
62
63 /* Allocate and initialise structure */
64 pixbuf = zalloc ( sizeof ( *pixbuf ) );
65 if ( ! pixbuf )
66 goto err_alloc_pixbuf;
67 ref_init ( &pixbuf->refcnt, free_pixbuf );
68 pixbuf->width = width;
69 pixbuf->height = height;
70 pixbuf->pixels = ( width * height );
71 pixbuf->len = ( pixbuf->pixels * sizeof ( uint32_t ) );
72
73 /* Check for multiplication overflow */
74 if ( ( width != 0 ) &&
75 ( ( pixbuf->len / sizeof ( uint32_t ) ) / width ) != height ) {
76 goto err_overflow;
77 }
78
79 /* Allocate pixel data buffer */
80 pixbuf->data = umalloc ( pixbuf->len );
81 if ( ! pixbuf->data )
82 goto err_alloc_data;
83
84 return pixbuf;
85
86 err_alloc_data:
87 err_overflow:
88 pixbuf_put ( pixbuf );
89 err_alloc_pixbuf:
90 return NULL;
91}
#define NULL
NULL pointer (VOID *)
Definition Base.h:322
unsigned int uint32_t
Definition stdint.h:12
static __always_inline void * umalloc(size_t size)
Allocate external memory.
Definition umalloc.h:57
void * zalloc(size_t size)
Allocate cleared memory.
Definition malloc.c:662
static void free_pixbuf(struct refcnt *refcnt)
Free pixel buffer.
Definition pixbuf.c:45
#define ref_init(refcnt, free)
Initialise a reference counter.
Definition refcnt.h:65
unsigned int height
Height.
Definition pixbuf.h:23
unsigned int pixels
Total number of pixels.
Definition pixbuf.h:27
struct refcnt refcnt
Reference count.
Definition pixbuf.h:19
size_t len
Total length.
Definition pixbuf.h:29
unsigned int width
Width.
Definition pixbuf.h:21

References pixel_buffer::data, free_pixbuf(), pixel_buffer::height, pixel_buffer::len, NULL, pixel_buffer::pixels, ref_init, pixel_buffer::refcnt, umalloc(), pixel_buffer::width, and zalloc().

Referenced by png_image_header().

◆ image_pixbuf()

int image_pixbuf ( struct image * image,
struct pixel_buffer ** pixbuf )

Create pixel buffer from image.

Parameters
imageImage
pixbufPixel buffer to fill in
Return values
rcReturn status code

Definition at line 100 of file pixbuf.c.

100 {
101 int rc;
102
103 /* Check that this image can be used to create a pixel buffer */
104 if ( ! ( image->type && image->type->pixbuf ) )
105 return -ENOTSUP;
106
107 /* Try creating pixel buffer */
108 if ( ( rc = image->type->pixbuf ( image, pixbuf ) ) != 0 ) {
109 DBGC ( image, "IMAGE %s could not create pixel buffer: %s\n",
110 image->name, strerror ( rc ) );
111 return rc;
112 }
113
114 return 0;
115}
struct arbelprm_rc_send_wqe rc
Definition arbel.h:3
#define DBGC(...)
Definition compiler.h:505
#define ENOTSUP
Operation not supported.
Definition errno.h:590
char * strerror(int errno)
Retrieve string representation of error number.
Definition strerror.c:79
int(* pixbuf)(struct image *image, struct pixel_buffer **pixbuf)
Create pixel buffer from image.
Definition image.h:121
An executable image.
Definition image.h:24
struct image_type * type
Image type, if known.
Definition image.h:59
char * name
Name.
Definition image.h:38

References DBGC, ENOTSUP, image::name, image_type::pixbuf, rc, strerror(), and image::type.

Referenced by console_exec(), pixbuf_okx(), and REQUIRING_SYMBOL().

◆ REQUIRING_SYMBOL()

REQUIRING_SYMBOL ( image_pixbuf )

References image_pixbuf().

◆ REQUIRE_OBJECT()

REQUIRE_OBJECT ( config_pixbuf )