Fri Aug 17 00:17:41 2018

Asterisk developer's documentation


image.h File Reference

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

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.
int ast_image_register (struct ast_imager *imgdrv)
 Register image format.
void ast_image_unregister (struct ast_imager *imgdrv)
 Unregister an image format.
struct ast_frameast_read_image (const char *filename, const char *preflang, int format)
 Make an image.
int ast_send_image (struct ast_channel *chan, const char *filename)
 Sends an image.
int ast_supports_images (struct ast_channel *chan)
 Check for image support on a channel.

Detailed Description

General Asterisk channel definitions for image handling.

Definition in file image.h.


Function Documentation

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

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

Referenced by main().

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

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

Referenced by load_module().

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

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

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

Referenced by unload_module().

00060 {
00061    AST_RWLIST_WRLOCK(&imagers);
00062    img = AST_RWLIST_REMOVE(&imagers, img, list);
00063    AST_RWLIST_UNLOCK(&imagers);
00064 
00065    if (img)
00066       ast_verb(2, "Unregistered format '%s' (%s)\n", img->name, img->desc);
00067 }

struct ast_frame* ast_read_image ( const char *  filename,
const char *  preflang,
int  format 
) [read]

Make an image.

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
Return values:
an ast_frame on success
NULL on failure

Definition at line 103 of file image.c.

References ast_copy_string(), ast_log(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, errno, ast_imager::exts, f, file_exists(), ast_imager::format, ast_imager::identify, len(), LOG_WARNING, make_filename(), ast_imager::name, and ast_imager::read_image.

Referenced by ast_send_image().

00104 {
00105    struct ast_imager *i;
00106    char buf[256];
00107    char tmp[80];
00108    char *e;
00109    struct ast_imager *found = NULL;
00110    int fd;
00111    int len=0;
00112    struct ast_frame *f = NULL;
00113    
00114    AST_RWLIST_RDLOCK(&imagers);
00115    AST_RWLIST_TRAVERSE(&imagers, i, list) {
00116       if (i->format & format) {
00117          char *stringp=NULL;
00118          ast_copy_string(tmp, i->exts, sizeof(tmp));
00119          stringp = tmp;
00120          e = strsep(&stringp, "|");
00121          while (e) {
00122             make_filename(buf, sizeof(buf), filename, preflang, e);
00123             if ((len = file_exists(buf))) {
00124                found = i;
00125                break;
00126             }
00127             make_filename(buf, sizeof(buf), filename, NULL, e);
00128             if ((len = file_exists(buf))) {
00129                found = i;
00130                break;
00131             }
00132             e = strsep(&stringp, "|");
00133          }
00134       }
00135       if (found)
00136          break;   
00137    }
00138 
00139    if (found) {
00140       fd = open(buf, O_RDONLY);
00141       if (fd > -1) {
00142          if (!found->identify || found->identify(fd)) {
00143             /* Reset file pointer */
00144             lseek(fd, 0, SEEK_SET);
00145             f = found->read_image(fd, len); 
00146          } else
00147             ast_log(LOG_WARNING, "%s does not appear to be a %s file\n", buf, found->name);
00148          close(fd);
00149       } else
00150          ast_log(LOG_WARNING, "Unable to open '%s': %s\n", buf, strerror(errno));
00151    } else
00152       ast_log(LOG_WARNING, "Image file '%s' not found\n", filename);
00153    
00154    AST_RWLIST_UNLOCK(&imagers);
00155    
00156    return f;
00157 }

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

References ast_frfree, ast_read_image(), f, ast_channel_tech::send_image, and ast_channel::tech.

Referenced by handle_sendimage(), and sendimage_exec().

00160 {
00161    struct ast_frame *f;
00162    int res = -1;
00163    if (chan->tech->send_image) {
00164       f = ast_read_image(filename, chan->language, -1);
00165       if (f) {
00166          res = chan->tech->send_image(chan, f);
00167          ast_frfree(f);
00168       }
00169    }
00170    return res;
00171 }

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

References ast_channel_tech::send_image, and ast_channel::tech.

Referenced by sendimage_exec().

00070 {
00071    if (!chan || !chan->tech)
00072       return 0;
00073    if (!chan->tech->send_image)
00074       return 0;
00075    return 1;
00076 }


Generated on 17 Aug 2018 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1