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.

Data Structures
struct	ast_imager
	structure associated with registering an image format More...

Functions
int	ast_image_init (void)
	Initialize image stuff Initializes all the various image stuff. Basically just registers the cli stuff. More...
int	ast_image_register (struct ast_imager *imgdrv)
	Register image format. More...
void	ast_image_unregister (struct ast_imager *imgdrv)
	Unregister an image format. More...
struct ast_frame *	ast_read_image (const char *filename, const char *preflang, struct ast_format *format)
	Make an image. More...
int	ast_send_image (struct ast_channel *chan, const char *filename)
	Sends an image. More...
int	ast_supports_images (struct ast_channel *chan)
	Check for image support on a channel. More...

Detailed Description

General Asterisk channel definitions for image handling.

Definition in file image.h.

Function Documentation

ast_image_init()

int ast_image_init

(

void

)

Initialize image stuff Initializes all the various image stuff. Basically just registers the cli stuff.

Returns

0 all the time

Definition at line 212 of file image.c.

References ARRAY_LEN, ast_cli_register_multiple, ast_register_cleanup(), and image_shutdown().

Referenced by asterisk_daemon().

{
   ast_cli_register_multiple(cli_image, ARRAY_LEN(cli_image));
   ast_register_cleanup(image_shutdown);
   return 0;
}

ast_image_register()

int ast_image_register

(

struct ast_imager *

imgdrv

)

Register image format.

Parameters

imgdrv

Populated ast_imager structure with info to register Registers an image format

Returns

0 regardless

Definition at line 48 of file image.c.

References AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, ast_imager::desc, and ast_imager::name.

{
   AST_RWLIST_WRLOCK(&imagers);
   AST_RWLIST_INSERT_HEAD(&imagers, img, list);
   AST_RWLIST_UNLOCK(&imagers);
   ast_verb(2, "Registered format '%s' (%s)\n", img->name, img->desc);
   return 0;
}

ast_image_unregister()

void ast_image_unregister

(

struct ast_imager *

imgdrv

)

Unregister an image format.

Parameters

imgdrv

pointer to the ast_imager structure you wish to unregister Unregisters the image format passed in. Returns nothing

Definition at line 57 of file image.c.

References AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, ast_imager::desc, and ast_imager::name.

{
   AST_RWLIST_WRLOCK(&imagers);
   img = AST_RWLIST_REMOVE(&imagers, img, list);
   AST_RWLIST_UNLOCK(&imagers);

   if (img)
      ast_verb(2, "Unregistered format '%s' (%s)\n", img->name, img->desc);
}

ast_read_image()

struct ast_frame* ast_read_image	(	const char *	filename,
		const char *	preflang,
		struct ast_format *	format
	)

Make an image.

Parameters

filename	filename of image to prepare
preflang	preferred language to get the image...?
format	the format of the file, NULL for any image format Make an image from a filename ??? No estoy positivo

Return values

an	ast_frame on success
NULL	on failure

Definition at line 101 of file image.c.

References ast_copy_string(), ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_log, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, buf, errno, ast_imager::exts, file_exists(), ast_imager::format, ast_imager::identify, len(), LOG_WARNING, make_filename(), ast_imager::name, NULL, ast_imager::read_image, strsep(), and tmp().

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;

   AST_RWLIST_RDLOCK(&imagers);
   AST_RWLIST_TRAVERSE(&imagers, i, list) {
      /* if NULL image format, just pick the first one, otherwise match it. */
      if (!format || (ast_format_cmp(i->format, format) == AST_FORMAT_CMP_EQUAL)) {
         char *stringp=NULL;
         ast_copy_string(tmp, i->exts, sizeof(tmp));
         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, "|");
         }
      }
      if (found)
         break;
   }

   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);

   AST_RWLIST_UNLOCK(&imagers);

   return f;
}

ast_send_image()

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

Sends an image.

Parameters

chan	channel to send image on
filename	filename of image to send (minus extension) Sends an image on the given channel.

Return values

0	on success
-1	on error

Definition at line 158 of file image.c.

References ast_channel_language(), ast_channel_tech(), ast_frfree, ast_read_image(), NULL, and ast_channel_tech::send_image.

Referenced by handle_sendimage(), and sendimage_exec().

{
   struct ast_frame *f;
   int res = -1;
   if (ast_channel_tech(chan)->send_image) {
      f = ast_read_image(filename, ast_channel_language(chan), NULL);
      if (f) {
         res = ast_channel_tech(chan)->send_image(chan, f);
         ast_frfree(f);
      }
   }
   return res;
}

ast_supports_images()

int ast_supports_images

(

struct ast_channel *

chan

)

Check for image support on a channel.

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 67 of file image.c.

References ast_channel_tech().

Referenced by sendimage_exec().

{
   if (!chan || !ast_channel_tech(chan))
      return 0;
   if (!ast_channel_tech(chan)->send_image)
      return 0;
   return 1;
}