Sun Aug 6 15:11:59 2006

Asterisk developer's documentation

---

image.h File Reference

General Asterisk channel definitions for image handling. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	ast_image_init (void)
int	ast_image_register (struct ast_imager *imgdrv)
void	ast_image_unregister (struct ast_imager *imgdrv)
ast_frame *	ast_read_image (char *filename, char *preflang, int format)
int	ast_send_image (struct ast_channel *chan, char *filename)
int	ast_supports_images (struct ast_channel *chan)

---

Detailed Description

General Asterisk channel definitions for image handling.

Definition in file image.h.

---

Function Documentation

int ast_image_init (  void   )

Initializes all the various image stuff. Basically just registers the cli stuff Returns 0 all the time Definition at line 214 of file image.c. References ast_cli_register(). Referenced by main(). { ast_cli_register(&show_images); return 0; }

int ast_image_register (  struct ast_imager *  imgdrv  )

Parameters: imgdrv  Populated ast_imager structure with info to register Registers an image format Returns 0 regardless Definition at line 51 of file image.c. References ast_mutex_lock(), ast_mutex_unlock(), ast_verbose(), ast_imager::desc, ast_imager::name, ast_imager::next, option_verbose, and VERBOSE_PREFIX_2. Referenced by load_module(). { if (option_verbose > 1) ast_verbose(VERBOSE_PREFIX_2 "Registered format '%s' (%s)\n", img->name, img->desc); ast_mutex_lock(&listlock); img->next = list; list = img; ast_mutex_unlock(&listlock); return 0; }

void ast_image_unregister (  struct ast_imager *  imgdrv  )

Parameters: imgdrv  pointer to the ast_imager structure you wish to unregister Unregisters the image format passed in Returns nothing Definition at line 62 of file image.c. References ast_mutex_lock(), ast_mutex_unlock(), ast_verbose(), ast_imager::desc, ast_imager::name, ast_imager::next, option_verbose, and VERBOSE_PREFIX_2. Referenced by unload_module(). { struct ast_imager *i, *prev = NULL; ast_mutex_lock(&listlock); i = list; while(i) { if (i == img) { if (prev) prev->next = i->next; else list = i->next; break; } prev = i; i = i->next; } ast_mutex_unlock(&listlock); if (i && (option_verbose > 1)) ast_verbose(VERBOSE_PREFIX_2 "Unregistered format '%s' (%s)\n", img->name, img->desc); }

struct ast_frame* ast_read_image (  char *  filename, char *  preflang, int  format )

Parameters: filename  filename of image to prepare preflang  preferred language to get the image...? format  the format of the file Make an image from a filename ??? No estoy positivo Returns an ast_frame on success, NULL on failure Definition at line 117 of file image.c. References ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_imager::exts, file_exists(), ast_imager::format, ast_imager::identify, LOG_WARNING, make_filename(), ast_imager::name, ast_imager::next, ast_imager::read_image, and strsep(). Referenced by ast_send_image(). { struct ast_imager *i; char buf[256]; char tmp[80]; char *e; struct ast_imager *found = NULL; int fd; int len=0; struct ast_frame *f = NULL; #if 0 /* We need to have some sort of read-only lock */ ast_mutex_lock(&listlock); #endif i = list; while(!found && i) { if (i->format & format) { char *stringp=NULL; strncpy(tmp, i->exts, sizeof(tmp)-1); stringp=tmp; e = strsep(&stringp, "|"); while(e) { make_filename(buf, sizeof(buf), filename, preflang, e); if ((len = file_exists(buf))) { found = i; break; } make_filename(buf, sizeof(buf), filename, NULL, e); if ((len = file_exists(buf))) { found = i; break; } e = strsep(&stringp, "|"); } } i = i->next; } if (found) { fd = open(buf, O_RDONLY); if (fd > -1) { if (!found->identify || found->identify(fd)) { /* Reset file pointer */ lseek(fd, 0, SEEK_SET); f = found->read_image(fd,len); } else ast_log(LOG_WARNING, "%s does not appear to be a %s file\n", buf, found->name); close(fd); } else ast_log(LOG_WARNING, "Unable to open '%s': %s\n", buf, strerror(errno)); } else ast_log(LOG_WARNING, "Image file '%s' not found\n", filename); #if 0 ast_mutex_unlock(&listlock); #endif return f; }

int ast_send_image (  struct ast_channel *  chan, char *  filename )

Parameters: chan  channel to send image on filename  filename of image to send (minus extension) Sends an image on the given channel. Returns 0 on success, -1 on error Definition at line 174 of file image.c. References ast_frfree(), ast_read_image(), ast_channel::language, ast_channel_tech::send_image, and ast_channel::tech. Referenced by handle_sendimage(), and sendimage_exec(). { struct ast_frame *f; int res = -1; if (chan->tech->send_image) { f = ast_read_image(filename, chan->language, -1); if (f) { res = chan->tech->send_image(chan, f); ast_frfree(f); } } return res; }

int ast_supports_images (  struct ast_channel *  chan  )

Parameters: chan  channel to check Checks the channel to see if it supports the transmission of images Returns non-zero if image transmission is supported Definition at line 83 of file image.c. References ast_channel_tech::send_image, and ast_channel::tech. Referenced by sendimage_exec(). { if (!chan || !chan->tech) return 0; if (!chan->tech->send_image) return 0; return 1; }

---