iPXE
Functions
pixbuf.c File Reference

Pixel buffer. More...

#include <stdlib.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)
 
static void free_pixbuf (struct refcnt *refcnt)
 Free pixel buffer. More...
 
struct pixel_bufferalloc_pixbuf (unsigned int width, unsigned int height)
 Allocate pixel buffer. More...
 
int image_pixbuf (struct image *image, struct pixel_buffer **pixbuf)
 Create pixel buffer from image. More...
 
 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  )

◆ free_pixbuf()

static void free_pixbuf ( struct refcnt refcnt)
static

Free pixel buffer.

Parameters
refcntReference count

Definition at line 43 of file pixbuf.c.

43  {
44  struct pixel_buffer *pixbuf =
46 
47  ufree ( pixbuf->data );
48  free ( pixbuf );
49 }
A reference counter.
Definition: refcnt.h:26
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
A pixel buffer.
Definition: pixbuf.h:17
static __always_inline void ufree(userptr_t userptr)
Free external memory.
Definition: umalloc.h:65
userptr_t data
32-bit (8:8:8:8) xRGB pixel data, in host-endian order
Definition: pixbuf.h:25

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 58 of file pixbuf.c.

58  {
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 }
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
unsigned int height
Height.
Definition: pixbuf.h:23
size_t len
Total length.
Definition: pixbuf.h:27
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
A pixel buffer.
Definition: pixbuf.h:17
struct refcnt refcnt
Reference count.
Definition: pixbuf.h:19
unsigned int uint32_t
Definition: stdint.h:12
static __always_inline userptr_t umalloc(size_t size)
Allocate external memory.
Definition: umalloc.h:54
userptr_t data
32-bit (8:8:8:8) xRGB pixel data, in host-endian order
Definition: pixbuf.h:25
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
unsigned int width
Width.
Definition: pixbuf.h:21

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

Referenced by png_image_header(), and pnm_pixbuf().

◆ 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 97 of file pixbuf.c.

97  {
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 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
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
#define ENOTSUP
Operation not supported.
Definition: errno.h:589
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
int(* pixbuf)(struct image *image, struct pixel_buffer **pixbuf)
Create pixel buffer from image.
Definition: image.h:102
char * name
Name.
Definition: image.h:34

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

Referenced by console_exec(), and pixbuf_okx().

◆ REQUIRING_SYMBOL()

REQUIRING_SYMBOL ( image_pixbuf  )

◆ REQUIRE_OBJECT()

REQUIRE_OBJECT ( config_pixbuf  )