59fbee5fffcde8be9496feb55052428244264895
[asterisk/asterisk.git] / include / asterisk / channel.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief General Asterisk PBX channel definitions.
21  * \par See also:
22  *  \arg \ref Def_Channel
23  *  \arg \ref channel_drivers
24  */
25
26 /*! \page Def_Channel Asterisk Channels
27         \par What is a Channel?
28         A phone call through Asterisk consists of an incoming
29         connection and an outbound connection. Each call comes
30         in through a channel driver that supports one technology,
31         like SIP, ZAP, IAX2 etc. 
32         \par
33         Each channel driver, technology, has it's own private
34         channel or dialog structure, that is technology-dependent.
35         Each private structure is "owned" by a generic Asterisk
36         channel structure, defined in channel.h and handled by
37         channel.c .
38         \par Call scenario
39         This happens when an incoming call arrives to Asterisk
40         -# Call arrives on a channel driver interface
41         -# Channel driver creates a PBX channel and starts a 
42            pbx thread on the channel
43         -# The dial plan is executed
44         -# At this point at least two things can happen:
45                 -# The call is answered by Asterisk and 
46                    Asterisk plays a media stream or reads media
47                 -# The dial plan forces Asterisk to create an outbound 
48                    call somewhere with the dial (see \ref app_dial.c)
49                    application
50         .
51
52         \par Bridging channels
53         If Asterisk dials out this happens:
54         -# Dial creates an outbound PBX channel and asks one of the
55            channel drivers to create a call
56         -# When the call is answered, Asterisk bridges the media streams
57            so the caller on the first channel can speak with the callee
58            on the second, outbound channel
59         -# In some cases where we have the same technology on both
60            channels and compatible codecs, a native bridge is used.
61            In a native bridge, the channel driver handles forwarding
62            of incoming audio to the outbound stream internally, without
63            sending audio frames through the PBX.
64         -# In SIP, theres an "external native bridge" where Asterisk
65            redirects the endpoint, so audio flows directly between the
66            caller's phone and the callee's phone. Signalling stays in
67            Asterisk in order to be able to provide a proper CDR record
68            for the call.
69
70         
71         \par Masquerading channels
72         In some cases, a channel can masquerade itself into another
73         channel. This happens frequently in call transfers, where 
74         a new channel takes over a channel that is already involved
75         in a call. The new channel sneaks in and takes over the bridge
76         and the old channel, now a zombie, is hung up.
77         
78         \par Reference
79         \arg channel.c - generic functions
80         \arg channel.h - declarations of functions, flags and structures
81         \arg \ref channel_drivers - Implemented channel drivers
82         \arg \ref Def_Frame Asterisk Multimedia Frames
83
84 */
85
86 #ifndef _ASTERISK_CHANNEL_H
87 #define _ASTERISK_CHANNEL_H
88
89 #include <unistd.h>
90 #ifdef POLLCOMPAT 
91 #include "asterisk/poll-compat.h"
92 #else
93 #include <sys/poll.h>
94 #endif
95
96 #if defined(__cplusplus) || defined(c_plusplus)
97 extern "C" {
98 #endif
99
100 /*! Max length of an extension */
101 #define AST_MAX_EXTENSION       80
102
103 #define AST_MAX_CONTEXT         80
104
105 #define AST_CHANNEL_NAME        80
106
107 #include "asterisk/compat.h"
108 #include "asterisk/frame.h"
109 #include "asterisk/sched.h"
110 #include "asterisk/chanvars.h"
111 #include "asterisk/config.h"
112 #include "asterisk/lock.h"
113 #include "asterisk/cdr.h"
114 #include "asterisk/utils.h"
115 #include "asterisk/linkedlists.h"
116
117 #define MAX_LANGUAGE            20
118
119 #define MAX_MUSICCLASS          20
120
121 #define AST_MAX_FDS             8
122
123 enum ast_bridge_result {
124         AST_BRIDGE_COMPLETE = 0,
125         AST_BRIDGE_FAILED = -1,
126         AST_BRIDGE_FAILED_NOWARN = -2,
127         AST_BRIDGE_RETRY = -3,
128 };
129
130 typedef unsigned long long ast_group_t;
131
132 struct ast_generator {
133         void *(*alloc)(struct ast_channel *chan, void *params);
134         void (*release)(struct ast_channel *chan, void *data);
135         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
136 };
137
138 /*! Structure for all kinds of caller ID identifications */
139 struct ast_callerid {
140         /*! Malloc'd Dialed Number Identifier */
141         char *cid_dnid;                         
142         /*! Malloc'd Caller Number */
143         char *cid_num;
144         /*! Malloc'd Caller Name */
145         char *cid_name;
146         /*! Malloc'd ANI */
147         char *cid_ani;                  
148         /*! Malloc'd RDNIS */
149         char *cid_rdnis;
150         /*! Callerid presentation/screening */
151         int cid_pres;
152         /*! Callerid ANI 2 (Info digits) */
153         int cid_ani2;
154         /*! Callerid Type of Number */
155         int cid_ton;
156         /*! Callerid Transit Network Select */
157         int cid_tns;
158 };
159
160 /*! Structure to describe a channel "technology", ie a channel driver 
161         See
162         \arg chan_iax2.c - The Inter-Asterisk exchange protocol
163         \arg chan_sip.c - The SIP channel driver
164         \arg chan_zap.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
165
166         If you develop your own channel driver, this is where you
167         tell the PBX at registration of your driver what properties
168         this driver supports and where different callbacks are 
169         implemented.
170 */
171         
172
173 struct ast_channel_tech {
174         const char * const type;
175         const char * const description;
176
177         /*! Bitmap of formats this channel can handle */
178         int capabilities;
179
180         /*! Technology Properties */
181         int properties;
182
183         /*! Requester - to set up call data structures (pvt's) */
184         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
185
186         /*! Devicestate call back */
187         int (* const devicestate)(void *data);
188
189         /*! Send a literal DTMF digit */
190         int (* const send_digit)(struct ast_channel *chan, char digit);
191
192         /*! Call a given phone number (address, etc), but don't
193            take longer than timeout seconds to do so.  */
194         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
195
196         /*! Hangup (and possibly destroy) the channel */
197         int (* const hangup)(struct ast_channel *chan);
198
199         /*! Answer the channel */
200         int (* const answer)(struct ast_channel *chan);
201
202         /*! Read a frame, in standard format (see frame.h) */
203         struct ast_frame * (* const read)(struct ast_channel *chan);
204
205         /*! Write a frame, in standard format (see frame.h) */
206         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
207
208         /*! Display or transmit text */
209         int (* const send_text)(struct ast_channel *chan, const char *text);
210
211         /*! Display or send an image */
212         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
213
214         /*! Send HTML data */
215         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
216
217         /*! Handle an exception, reading a frame */
218         struct ast_frame * (* const exception)(struct ast_channel *chan);
219
220         /*! Bridge two channels of the same type together */
221         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
222                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
223
224         /*! Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
225         int (* const indicate)(struct ast_channel *c, int condition);
226
227         /*! Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
228         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
229
230         /*! Set a given option */
231         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
232
233         /*! Query a given option */
234         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
235
236         /*! Blind transfer other side (see app_transfer.c and ast_transfer() */
237         int (* const transfer)(struct ast_channel *chan, const char *newdest);
238
239         /*! Write a frame, in standard format */
240         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
241
242         /*! Find bridged channel */
243         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
244 };
245
246 struct ast_channel_spy_list;
247
248 /*! Main Channel structure associated with a channel. 
249  * This is the side of it mostly used by the pbx and call management.
250  */
251 struct ast_channel {
252         /*! ASCII unique channel name */
253         char name[AST_CHANNEL_NAME];
254         
255         /*! Technology (point to channel driver) */
256         const struct ast_channel_tech *tech;
257
258         /*! Private data used by the technology driver */
259         void *tech_pvt;
260
261         /*! Language requested for voice prompts */
262         char language[MAX_LANGUAGE];            
263         /*! Type of channel */
264         const char *type;                               
265         /*! File descriptor for channel -- Drivers will poll on these file descriptors, so at least one must be non -1.  */
266         int fds[AST_MAX_FDS];                   
267
268         /*! Default music class */
269         char musicclass[MAX_MUSICCLASS];
270         /*! Music State*/
271         void *music_state;
272         /*! Current generator data if there is any */
273         void *generatordata;
274         /*! Current active data generator */
275         struct ast_generator *generator;
276
277         /*! Who are we bridged to, if we're bridged  Do not access directly,
278             use ast_bridged_channel(chan) */
279         struct ast_channel *_bridge;
280         /*! Channel that will masquerade as us */
281         struct ast_channel *masq;               
282         /*! Who we are masquerading as */
283         struct ast_channel *masqr;              
284         /*! Call Detail Record Flags */
285         int cdrflags;                                                                              
286         /*! Whether or not we have been hung up...  Do not set this value
287             directly, use ast_softhangup */
288         int _softhangup;
289         /*! Non-zero, set to actual time when channel is to be hung up */
290         time_t  whentohangup;
291         /*! If anyone is blocking, this is them */
292         pthread_t blocker;                      
293         /*! Lock, can be used to lock a channel for some operations */
294         ast_mutex_t lock;                       
295         /*! Procedure causing blocking */
296         const char *blockproc;                  
297
298         /*! Current application */
299         char *appl;                             
300         /*! Data passed to current application */
301         char *data;                             
302         
303         /*! Which fd had an event detected on */
304         int fdno;                               
305         /*! Schedule context */
306         struct sched_context *sched;            
307         /*! For streaming playback, the schedule ID */
308         int streamid;                           
309         /*! Stream itself. */
310         struct ast_filestream *stream;          
311         /*! For streaming video playback, the schedule ID */
312         int vstreamid;                          
313         /*! Video Stream itself. */
314         struct ast_filestream *vstream;         
315         /*! Original writer format */
316         int oldwriteformat;                     
317         
318         /*! Timing fd */
319         int timingfd;
320         int (*timingfunc)(void *data);
321         void *timingdata;
322
323         /*! State of line -- Don't write directly, use ast_setstate */
324         int _state;                             
325         /*! Number of rings so far */
326         int rings;                              
327
328         /*! Kinds of data this channel can natively handle */
329         int nativeformats;                      
330         /*! Requested read format */
331         int readformat;                         
332         /*! Requested write format */
333         int writeformat;                        
334
335         struct ast_callerid cid;
336                 
337         /*! Current extension context */
338         char context[AST_MAX_CONTEXT];
339         /*! Current non-macro context */
340         char macrocontext[AST_MAX_CONTEXT];     
341         /*! Current non-macro extension */
342         char macroexten[AST_MAX_EXTENSION];
343         /*! Current non-macro priority */
344         int macropriority;
345         /*! Current extension number */
346         char exten[AST_MAX_EXTENSION];          
347         /* Current extension priority */
348         int priority;                                           
349         /*! Any/all queued DTMF characters */
350         char dtmfq[AST_MAX_EXTENSION];          
351         /*! DTMF frame */
352         struct ast_frame dtmff;                 
353
354         /*! PBX private structure */
355         struct ast_pbx *pbx;
356         /*! Set BEFORE PBX is started to determine AMA flags */
357         int amaflags;                   
358         /*! Account code for billing */
359         char accountcode[AST_MAX_ACCOUNT_CODE];         
360         /*! Call Detail Record */
361         struct ast_cdr *cdr;                    
362         /*! Whether or not ADSI is detected on CPE */
363         int adsicpe;
364         /*! Where to forward to if asked to dial on this interface */
365         char call_forward[AST_MAX_EXTENSION];
366
367         /*! Tone zone as set in indications.conf */
368         struct tone_zone *zone;
369
370         /* Channel monitoring */
371         struct ast_channel_monitor *monitor;
372
373         /*! Track the read/written samples for monitor use */
374         unsigned long insmpl;
375         unsigned long outsmpl;
376
377         /* Frames in/out counters */
378         unsigned int fin;
379         unsigned int fout;
380
381         /* Unique Channel Identifier */
382         char uniqueid[32];
383
384         /* Why is the channel hanged up */
385         int hangupcause;
386         
387         /* A linked list for variables */
388         struct varshead varshead;
389
390         unsigned int callgroup;
391         unsigned int pickupgroup;
392
393         /*! channel flags of AST_FLAG_ type */
394         unsigned int flags;
395         
396         /*! ISDN Transfer Capbility - AST_FLAG_DIGITAL is not enough */
397         unsigned short transfercapability;
398
399         struct ast_frame *readq;
400         int alertpipe[2];
401         /*! Write translation path */
402         struct ast_trans_pvt *writetrans;
403         /*! Read translation path */
404         struct ast_trans_pvt *readtrans;
405         /*! Raw read format */
406         int rawreadformat;
407         /*! Raw write format */
408         int rawwriteformat;
409
410         /*! Chan Spy stuff */
411         struct ast_channel_spy_list *spies;
412
413         /*! For easy linking */
414         AST_LIST_ENTRY(ast_channel) list;
415 };
416
417 /* \defgroup chanprop Channel tech properties:
418         \brief Channels have this property if they can accept input with jitter; i.e. most VoIP channels */
419 /* @{ */
420 #define AST_CHAN_TP_WANTSJITTER (1 << 0)        
421
422 /* This flag has been deprecated by the transfercapbilty data member in struct ast_channel */
423 /* #define AST_FLAG_DIGITAL     (1 << 0) */     /* if the call is a digital ISDN call */
424 #define AST_FLAG_DEFER_DTMF     (1 << 1)        /*!< if dtmf should be deferred */
425 #define AST_FLAG_WRITE_INT      (1 << 2)        /*!< if write should be interrupt generator */
426 #define AST_FLAG_BLOCKING       (1 << 3)        /*!< if we are blocking */
427 #define AST_FLAG_ZOMBIE         (1 << 4)        /*!< if we are a zombie */
428 #define AST_FLAG_EXCEPTION      (1 << 5)        /*!< if there is a pending exception */
429 #define AST_FLAG_MOH            (1 << 6)        /*!< XXX anthm promises me this will disappear XXX listening to moh */
430 #define AST_FLAG_SPYING         (1 << 7)        /*!< XXX might also go away XXX is spying on someone */
431 #define AST_FLAG_NBRIDGE        (1 << 8)        /*!< is it in a native bridge */
432 #define AST_FLAG_IN_AUTOLOOP    (1 << 9)        /*!< the channel is in an auto-incrementing dialplan processor,
433                                                    so when ->priority is set, it will get incremented before
434                                                    finding the next priority to run
435                                                 */
436 /* @} */
437
438 #define AST_FEATURE_PLAY_WARNING        (1 << 0)
439 #define AST_FEATURE_REDIRECT            (1 << 1)
440 #define AST_FEATURE_DISCONNECT          (1 << 2)
441 #define AST_FEATURE_ATXFER              (1 << 3)
442 #define AST_FEATURE_AUTOMON             (1 << 4)
443
444 #define AST_FEATURE_FLAG_NEEDSDTMF      (1 << 0)
445 #define AST_FEATURE_FLAG_CALLEE         (1 << 1)
446 #define AST_FEATURE_FLAG_CALLER         (1 << 2)
447
448 struct ast_bridge_config {
449         struct ast_flags features_caller;
450         struct ast_flags features_callee;
451         struct timeval start_time;
452         long feature_timer;
453         long timelimit;
454         long play_warning;
455         long warning_freq;
456         const char *warning_sound;
457         const char *end_sound;
458         const char *start_sound;
459         int firstpass;
460         unsigned int flags;
461 };
462
463 struct chanmon;
464
465 #define LOAD_OH(oh) {   \
466         oh.context = context; \
467         oh.exten = exten; \
468         oh.priority = priority; \
469         oh.cid_num = cid_num; \
470         oh.cid_name = cid_name; \
471         oh.vars = vars; \
472         oh.parent_channel = NULL; \
473
474
475 struct outgoing_helper {
476         const char *context;
477         const char *exten;
478         int priority;
479         const char *cid_num;
480         const char *cid_name;
481         struct ast_variable *vars;
482         struct ast_channel *parent_channel;
483 };
484
485 #define AST_CDR_TRANSFER        (1 << 0)
486 #define AST_CDR_FORWARD         (1 << 1)
487 #define AST_CDR_CALLWAIT        (1 << 2)
488 #define AST_CDR_CONFERENCE      (1 << 3)
489
490 #define AST_ADSI_UNKNOWN        (0)
491 #define AST_ADSI_AVAILABLE      (1)
492 #define AST_ADSI_UNAVAILABLE    (2)
493 #define AST_ADSI_OFFHOOKONLY    (3)
494
495 #define AST_SOFTHANGUP_DEV              (1 << 0)        /*!< Soft hangup by device */
496 #define AST_SOFTHANGUP_ASYNCGOTO        (1 << 1)        /*!< Soft hangup for async goto */
497 #define AST_SOFTHANGUP_SHUTDOWN         (1 << 2)
498 #define AST_SOFTHANGUP_TIMEOUT          (1 << 3)
499 #define AST_SOFTHANGUP_APPUNLOAD        (1 << 4)
500 #define AST_SOFTHANGUP_EXPLICIT         (1 << 5)
501 #define AST_SOFTHANGUP_UNBRIDGE     (1 << 6)
502
503
504 /*! \defgroup ChanState Channel states
505 \brief Bits 0-15 of state are reserved for the state (up/down) of the line */
506 /*! @{ */
507 /*! Channel is down and available */
508 #define AST_STATE_DOWN          0               
509 /*! Channel is down, but reserved */
510 #define AST_STATE_RESERVED      1               
511 /*! Channel is off hook */
512 #define AST_STATE_OFFHOOK       2               
513 /*! Digits (or equivalent) have been dialed */
514 #define AST_STATE_DIALING       3               
515 /*! Line is ringing */
516 #define AST_STATE_RING          4               
517 /*! Remote end is ringing */
518 #define AST_STATE_RINGING       5               
519 /*! Line is up */
520 #define AST_STATE_UP            6               
521 /*! Line is busy */
522 #define AST_STATE_BUSY          7               
523 /*! Digits (or equivalent) have been dialed while offhook */
524 #define AST_STATE_DIALING_OFFHOOK       8
525 /*! Channel has detected an incoming call and is waiting for ring */
526 #define AST_STATE_PRERING       9
527
528 /* Bits 16-32 of state are reserved for flags (See \ref ChanState ) */
529 /*! Do not transmit voice data */
530 #define AST_STATE_MUTE          (1 << 16)       
531 /*! @} */
532
533 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
534 enum channelreloadreason {
535         CHANNEL_MODULE_LOAD,
536         CHANNEL_MODULE_RELOAD,
537         CHANNEL_CLI_RELOAD,
538         CHANNEL_MANAGER_RELOAD,
539 };
540
541 /*! \brief Change the state of a channel */
542 int ast_setstate(struct ast_channel *chan, int state);
543
544 /*! \brief Create a channel structure 
545     \return Returns NULL on failure to allocate.
546         \note New channels are 
547         by default set to the "default" context and
548         extension "s"
549  */
550 struct ast_channel *ast_channel_alloc(int needalertpipe);
551
552 /*! \brief Queue an outgoing frame */
553 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
554
555 /*! \brief Queue a hangup frame */
556 int ast_queue_hangup(struct ast_channel *chan);
557
558 /*! \brief Queue a control frame */
559 int ast_queue_control(struct ast_channel *chan, int control);
560
561
562 /*! \brief Change channel name */
563 void ast_change_name(struct ast_channel *chan, char *newname);
564
565 /*! \brief Free a channel structure */
566 void  ast_channel_free(struct ast_channel *);
567
568 /*! \brief Requests a channel 
569  * \param type type of channel to request
570  * \param format requested channel format
571  * \param data data to pass to the channel requester
572  * \param status status
573  * Request a channel of a given type, with data as optional information used 
574  * by the low level module
575  * \return Returns an ast_channel on success, NULL on failure.
576  */
577 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
578
579 /*!
580  * \brief Request a channel of a given type, with data as optional information used 
581  * by the low level module and attempt to place a call on it
582  * \param type type of channel to request
583  * \param format requested channel format
584  * \param data data to pass to the channel requester
585  * \param timeout maximum amount of time to wait for an answer
586  * \param reason why unsuccessful (if unsuceessful)
587  * \param cidnum Caller-ID Number
588  * \param cidname Caller-ID Name
589  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
590  * to know if the call was answered or not.
591  */
592 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname);
593
594 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname, struct outgoing_helper *oh);
595
596 /*!\brief Register a channel technology (a new channel driver)
597  * Called by a channel module to register the kind of channels it supports.
598  * \param tech Structure defining channel technology or "type"
599  * \return Returns 0 on success, -1 on failure.
600  */
601 int ast_channel_register(const struct ast_channel_tech *tech);
602
603 /*! \brief Unregister a channel technology 
604  * \param tech Structure defining channel technology or "type" that was previously registered
605  * \return No return value.
606  */
607 void ast_channel_unregister(const struct ast_channel_tech *tech);
608
609 /*! \brief Get a channel technology structure by name
610  * \param name name of technology to find
611  * \return a pointer to the structure, or NULL if no matching technology found
612  */
613 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
614
615 /*! \brief Hang up a channel  
616  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
617  * performs all stream stopping, etc, on the channel that needs to end.
618  * chan is no longer valid after this call.
619  * \param chan channel to hang up
620  * \return Returns 0 on success, -1 on failure.
621  */
622 int ast_hangup(struct ast_channel *chan);
623
624 /*! \brief Softly hangup up a channel 
625  * \param chan channel to be soft-hung-up
626  * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
627  * safely hangup a channel managed by another thread.
628  * \param cause Ast hangupcause for hangup
629  * \return Returns 0 regardless
630  */
631 int ast_softhangup(struct ast_channel *chan, int cause);
632
633 /*! \brief Softly hangup up a channel (no channel lock) 
634  * \param chan channel to be soft-hung-up
635  * \param cause Ast hangupcause for hangup (see cause.h) */
636 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
637
638 /*! \brief Check to see if a channel is needing hang up 
639  * \param chan channel on which to check for hang up
640  * This function determines if the channel is being requested to be hung up.
641  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
642  */
643 int ast_check_hangup(struct ast_channel *chan);
644
645 /*! \brief Compare a offset with the settings of when to hang a channel up 
646  * \param chan channel on which to check for hang up
647  * \param offset offset in seconds from current time
648  * \return 1, 0, or -1
649  * This function compares a offset from current time with the absolute time 
650  * out on a channel (when to hang up). If the absolute time out on a channel
651  * is earlier than current time plus the offset, it returns 1, if the two
652  * time values are equal, it return 0, otherwise, it retturn -1.
653  */
654 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset);
655
656 /*! \brief Set when to hang a channel up 
657  * \param chan channel on which to check for hang up
658  * \param offset offset in seconds from current time of when to hang up
659  * This function sets the absolute time out on a channel (when to hang up).
660  */
661 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset);
662
663 /*! \brief Answer a ringing call 
664  * \param chan channel to answer
665  * This function answers a channel and handles all necessary call
666  * setup functions.
667  * \return Returns 0 on success, -1 on failure
668  */
669 int ast_answer(struct ast_channel *chan);
670
671 /*! \brief Make a call 
672  * \param chan which channel to make the call on
673  * \param addr destination of the call
674  * \param timeout time to wait on for connect
675  * Place a call, take no longer than timeout ms. 
676    \return Returns -1 on failure, 0 on not enough time 
677    (does not automatically stop ringing), and  
678    the number of seconds the connect took otherwise.
679    */
680 int ast_call(struct ast_channel *chan, char *addr, int timeout);
681
682 /*! \brief Indicates condition of channel 
683  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
684  * \param chan channel to change the indication
685  * \param condition which condition to indicate on the channel
686  * \return Returns 0 on success, -1 on failure
687  */
688 int ast_indicate(struct ast_channel *chan, int condition);
689
690 /* Misc stuff ------------------------------------------------ */
691
692 /*! \brief Wait for input on a channel 
693  * \param chan channel to wait on
694  * \param ms length of time to wait on the channel
695  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 
696   \return Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
697 int ast_waitfor(struct ast_channel *chan, int ms);
698
699 /*! \brief Wait for a specied amount of time, looking for hangups 
700  * \param chan channel to wait for
701  * \param ms length of time in milliseconds to sleep
702  * Waits for a specified amount of time, servicing the channel as required.
703  * \return returns -1 on hangup, otherwise 0.
704  */
705 int ast_safe_sleep(struct ast_channel *chan, int ms);
706
707 /*! \brief Wait for a specied amount of time, looking for hangups and a condition argument 
708  * \param chan channel to wait for
709  * \param ms length of time in milliseconds to sleep
710  * \param cond a function pointer for testing continue condition
711  * \param data argument to be passed to the condition test function
712  * \return returns -1 on hangup, otherwise 0.
713  * Waits for a specified amount of time, servicing the channel as required. If cond
714  * returns 0, this function returns.
715  */
716 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
717
718 /*! \brief Waits for activity on a group of channels 
719  * \param chan an array of pointers to channels
720  * \param n number of channels that are to be waited upon
721  * \param fds an array of fds to wait upon
722  * \param nfds the number of fds to wait upon
723  * \param exception exception flag
724  * \param outfd fd that had activity on it
725  * \param ms how long the wait was
726  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
727    file descriptors.
728    \return Returns the channel with activity, or NULL on error or if an FD
729    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
730    will be -1 */
731 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms);
732
733 /*! Waits for input on a group of channels */
734 /*! Wait for input on an array of channels for a given # of milliseconds. Return channel
735    with activity, or NULL if none has activity.  time "ms" is modified in-place, if applicable */
736 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
737
738 /*! Waits for input on an fd */
739 /*! This version works on fd's only.  Be careful with it. */
740 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
741
742
743 /*! Reads a frame */
744 /*!
745  * \param chan channel to read a frame from
746  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
747    best just stop reading frames and assume the channel has been
748    disconnected. */
749 struct ast_frame *ast_read(struct ast_channel *chan);
750
751 /*! Reads a frame, returning AST_FRAME_NULL frame if audio. */
752 /*!
753  * \param chan channel to read a frame from
754  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
755    best just stop reading frames and assume the channel has been
756    disconnected.  Audio is replaced with AST_FRAME_NULL to avoid 
757    transcode when the resulting audio is not necessary. */
758 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
759
760 /*! Write a frame to a channel */
761 /*!
762  * \param chan destination channel of the frame
763  * \param frame frame that will be written
764  * This function writes the given frame to the indicated channel.
765  * It returns 0 on success, -1 on failure.
766  */
767 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
768
769 /*! Write video frame to a channel */
770 /*!
771  * \param chan destination channel of the frame
772  * \param frame frame that will be written
773  * This function writes the given frame to the indicated channel.
774  * It returns 1 on success, 0 if not implemented, and -1 on failure.
775  */
776 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
777
778 /* Send empty audio to prime a channel driver */
779 int ast_prod(struct ast_channel *chan);
780
781 /*! Sets read format on channel chan */
782 /*! 
783  * \param chan channel to change
784  * \param format format to change to
785  * Set read format for channel to whichever component of "format" is best. 
786  * Returns 0 on success, -1 on failure
787  */
788 int ast_set_read_format(struct ast_channel *chan, int format);
789
790 /*! Sets write format on channel chan */
791 /*! 
792  * \param chan channel to change
793  * \param format new format for writing
794  * Set write format for channel to whichever compoent of "format" is best. 
795  * Returns 0 on success, -1 on failure
796  */
797 int ast_set_write_format(struct ast_channel *chan, int format);
798
799 /*! Sends text to a channel */
800 /*! 
801  * \param chan channel to act upon
802  * \param text string of text to send on the channel
803  * Write text to a display on a channel
804  * Returns 0 on success, -1 on failure
805  */
806 int ast_sendtext(struct ast_channel *chan, const char *text);
807
808 /*! Receives a text character from a channel */
809 /*! 
810  * \param chan channel to act upon
811  * \param timeout timeout in milliseconds (0 for infinite wait)
812  * Read a char of text from a channel
813  * Returns 0 on success, -1 on failure
814  */
815 int ast_recvchar(struct ast_channel *chan, int timeout);
816
817 /*! Send a DTMF digit to a channel */
818 /*! 
819  * \param chan channel to act upon
820  * \param digit the DTMF digit to send, encoded in ASCII
821  * Send a DTMF digit to a channel.
822  * Returns 0 on success, -1 on failure
823  */
824 int ast_senddigit(struct ast_channel *chan, char digit);
825
826 /*! Receives a text string from a channel */
827 /*! 
828  * \param chan channel to act upon
829  * \param timeout timeout in milliseconds (0 for infinite wait)
830  * \return the received text, or NULL to signify failure.
831  * Read a string of text from a channel
832  */
833 char *ast_recvtext(struct ast_channel *chan, int timeout);
834
835 /*! Browse channels in use */
836 /*! 
837  * \param prev where you want to start in the channel list
838  * Browse the channels currently in use 
839  * Returns the next channel in the list, NULL on end.
840  * If it returns a channel, that channel *has been locked*!
841  */
842 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
843
844 /*! Get channel by name (locks channel) */
845 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
846
847 /*! Get channel by name prefix (locks channel) */
848 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
849
850 /*! Get channel by name prefix (locks channel) */
851 struct ast_channel *ast_walk_channel_by_name_prefix_locked(struct ast_channel *chan, const char *name, const int namelen);
852
853 /*--- ast_get_channel_by_exten_locked: Get channel by exten (and optionally context) and lock it */
854 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context);
855
856 /*! Waits for a digit */
857 /*! 
858  * \param c channel to wait for a digit on
859  * \param ms how many milliseconds to wait
860  * Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
861 int ast_waitfordigit(struct ast_channel *c, int ms);
862
863 /* Same as above with audio fd for outputing read audio and ctrlfd to monitor for
864    reading. Returns 1 if ctrlfd becomes available */
865 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
866
867 /*! Reads multiple digits */
868 /*! 
869  * \param c channel to read from
870  * \param s string to read in to.  Must be at least the size of your length
871  * \param len how many digits to read (maximum)
872  * \param timeout how long to timeout between digits
873  * \param rtimeout timeout to wait on the first digit
874  * \param enders digits to end the string
875  * Read in a digit string "s", max length "len", maximum timeout between 
876    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
877    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
878    a timeout, any digits that were read before the timeout will still be available in s.  
879    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
880 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
881 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
882
883 /*! Report DTMF on channel 0 */
884 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
885 /*! Report DTMF on channel 1 */
886 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
887 /*! Return all voice frames on channel 0 */
888 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
889 /*! Return all voice frames on channel 1 */
890 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
891 /*! Ignore all signal frames except NULL */
892 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
893
894
895 /*! Makes two channel formats compatible */
896 /*! 
897  * \param c0 first channel to make compatible
898  * \param c1 other channel to make compatible
899  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  Returns 0 on success
900    and -1 if it could not be done */
901 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
902
903 /*! Bridge two channels together */
904 /*! 
905  * \param c0 first channel to bridge
906  * \param c1 second channel to bridge
907  * \param config config for the channels
908  * \param fo destination frame(?)
909  * \param rc destination channel(?)
910  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
911    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
912 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
913 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
914
915 /*! Weird function made for call transfers */
916 /*! 
917  * \param original channel to make a copy of
918  * \param clone copy of the original channel
919  * This is a very strange and freaky function used primarily for transfer.  Suppose that
920    "original" and "clone" are two channels in random situations.  This function takes
921    the guts out of "clone" and puts them into the "original" channel, then alerts the
922    channel driver of the change, asking it to fixup any private information (like the
923    p->owner pointer) that is affected by the change.  The physical layer of the original
924    channel is hung up.  */
925 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
926
927 /*! Gives the string form of a given cause code */
928 /*! 
929  * \param state cause to get the description of
930  * Give a name to a cause code
931  * Returns the text form of the binary cause code given
932  */
933 const char *ast_cause2str(int state);
934
935 /*! Gives the string form of a given channel state */
936 /*! 
937  * \param state state to get the name of
938  * Give a name to a state 
939  * Returns the text form of the binary state given
940  */
941 char *ast_state2str(int state);
942
943 /*! Gives the string form of a given transfer capability */
944 /*!
945  * \param transfercapability transfercapabilty to get the name of
946  * Give a name to a transfercapbility
947  * See above
948  * Returns the text form of the binary transfer capbility
949  */
950 char *ast_transfercapability2str(int transfercapability);
951
952 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
953    low level channel.  See frame.h for options.  Note that many channel drivers may support
954    none or a subset of those features, and you should not count on this if you want your
955    asterisk application to be portable.  They're mainly useful for tweaking performance */
956
957 /*! Sets an option on a channel */
958 /*! 
959  * \param channel channel to set options on
960  * \param option option to change
961  * \param data data specific to option
962  * \param datalen length of the data
963  * \param block blocking or not
964  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
965  * Returns 0 on success and -1 on failure
966  */
967 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
968
969 /*! Pick the best codec  */
970 /* Choose the best codec...  Uhhh...   Yah. */
971 extern int ast_best_codec(int fmts);
972
973
974 /*! Checks the value of an option */
975 /*! 
976  * Query the value of an option, optionally blocking until a reply is received
977  * Works similarly to setoption except only reads the options.
978  */
979 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
980
981 /*! Checks for HTML support on a channel */
982 /*! Returns 0 if channel does not support HTML or non-zero if it does */
983 int ast_channel_supports_html(struct ast_channel *channel);
984
985 /*! Sends HTML on given channel */
986 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
987 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
988
989 /*! Sends a URL on a given link */
990 /*! Send URL on link.  Returns 0 on success or -1 on failure */
991 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
992
993 /*! Defers DTMF */
994 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
995    non-zero if channel was already DTMF-deferred or 0 if channel is just now
996    being DTMF-deferred */
997 int ast_channel_defer_dtmf(struct ast_channel *chan);
998
999 /*! Undeos a defer */
1000 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
1001 void ast_channel_undefer_dtmf(struct ast_channel *chan);
1002
1003 /*! Initiate system shutdown -- prevents new channels from being allocated.
1004     If "hangup" is non-zero, all existing channels will receive soft
1005      hangups */
1006 void ast_begin_shutdown(int hangup);
1007
1008 /*! Cancels an existing shutdown and returns to normal operation */
1009 void ast_cancel_shutdown(void);
1010
1011 /*! Returns number of active/allocated channels */
1012 int ast_active_channels(void);
1013
1014 /*! Returns non-zero if Asterisk is being shut down */
1015 int ast_shutting_down(void);
1016
1017 /*! Activate a given generator */
1018 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
1019
1020 /*! Deactive an active generator */
1021 void ast_deactivate_generator(struct ast_channel *chan);
1022
1023 void ast_set_callerid(struct ast_channel *chan, const char *cidnum, const char *cidname, const char *ani);
1024
1025 /*! Start a tone going */
1026 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1027 /*! Stop a tone from playing */
1028 void ast_tonepair_stop(struct ast_channel *chan);
1029 /*! Play a tone pair for a given amount of time */
1030 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1031
1032 /*! Automatically service a channel for us... */
1033 int ast_autoservice_start(struct ast_channel *chan);
1034
1035 /*! Stop servicing a channel for us...  Returns -1 on error or if channel has been hungup */
1036 int ast_autoservice_stop(struct ast_channel *chan);
1037
1038 /* If built with zaptel optimizations, force a scheduled expiration on the
1039    timer fd, at which point we call the callback function / data */
1040 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
1041
1042 /*!     \brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
1043    and 1 if supported and requested 
1044         \param chan current channel
1045         \param dest destination extension for transfer
1046 */
1047 int ast_transfer(struct ast_channel *chan, char *dest);
1048
1049 /*!     \brief  Start masquerading a channel
1050         XXX This is a seriously wacked out operation.  We're essentially putting the guts of
1051            the clone channel into the original channel.  Start by killing off the original
1052            channel's backend.   I'm not sure we're going to keep this function, because
1053            while the features are nice, the cost is very high in terms of pure nastiness. XXX
1054         \param chan     Channel to masquerade
1055 */
1056 int ast_do_masquerade(struct ast_channel *chan);
1057
1058 /*!     \brief Find bridged channel 
1059         \param chan Current channel
1060 */
1061 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
1062
1063 /*!
1064   \brief Inherits channel variable from parent to child channel
1065   \param parent Parent channel
1066   \param child Child channel
1067
1068   Scans all channel variables in the parent channel, looking for those
1069   that should be copied into the child channel.
1070   Variables whose names begin with a single '_' are copied into the
1071   child channel with the prefix removed.
1072   Variables whose names begin with '__' are copied into the child
1073   channel with their names unchanged.
1074 */
1075 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
1076
1077 /*!
1078   \brief adds a list of channel variables to a channel
1079   \param chan the channel
1080   \param vars a linked list of variables
1081
1082   Variable names can be for a regular channel variable or a dialplan function
1083   that has the ability to be written to.
1084 */
1085 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
1086
1087 /*!
1088   \brief An opaque 'object' structure use by silence generators on channels.
1089  */
1090 struct ast_silence_generator;
1091
1092 /*!
1093   \brief Starts a silence generator on the given channel.
1094   \param chan The channel to generate silence on
1095   \return An ast_silence_generator pointer, or NULL if an error occurs
1096
1097   This function will cause SLINEAR silence to be generated on the supplied
1098   channel until it is disabled; if the channel cannot be put into SLINEAR
1099   mode then the function will fail.
1100
1101   The pointer returned by this function must be preserved and passed to
1102   ast_channel_stop_silence_generator when you wish to stop the silence
1103   generation.
1104  */
1105 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
1106
1107 /*!
1108   \brief Stops a previously-started silence generator on the given channel.
1109   \param chan The channel to operate on
1110   \param state The ast_silence_generator pointer return by a previous call to
1111   ast_channel_start_silence_generator.
1112   \return nothing
1113
1114   This function will stop the operating silence generator and return the channel
1115   to its previous write format.
1116  */
1117 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
1118
1119 /* Misc. functions below */
1120
1121 /* Helper function for migrating select to poll */
1122 static inline int ast_fdisset(struct pollfd *pfds, int fd, int max, int *start)
1123 {
1124         int x;
1125         for (x=start ? *start : 0;x<max;x++)
1126                 if (pfds[x].fd == fd) {
1127                         if (start) {
1128                                 if (x==*start)
1129                                         (*start)++;
1130                         }
1131                         return pfds[x].revents;
1132                 }
1133         return 0;
1134 }
1135
1136 #ifdef SOLARIS
1137 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
1138 {
1139         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
1140         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
1141         if (tvdiff->tv_usec < 0) {
1142                 tvdiff->tv_sec --;
1143                 tvdiff->tv_usec += 1000000;
1144         }
1145
1146 }
1147 #endif
1148
1149 /*! \brief Waits for activity on a group of channels 
1150  * \param nfds the maximum number of file descriptors in the sets
1151  * \param rfds file descriptors to check for read availability
1152  * \param wfds file descriptors to check for write availability
1153  * \param efds file descriptors to check for exceptions (OOB data)
1154  * \param tvp timeout while waiting for events
1155  * This is the same as a standard select(), except it guarantees the
1156  * behaviour where the passed struct timeval is updated with how much
1157  * time was not slept while waiting for the specified events
1158  */
1159 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1160 {
1161 #ifdef __linux__
1162         return select(nfds, rfds, wfds, efds, tvp);
1163 #else
1164         if (tvp) {
1165                 struct timeval tv, tvstart, tvend, tvlen;
1166                 int res;
1167
1168                 tv = *tvp;
1169                 gettimeofday(&tvstart, NULL);
1170                 res = select(nfds, rfds, wfds, efds, tvp);
1171                 gettimeofday(&tvend, NULL);
1172                 timersub(&tvend, &tvstart, &tvlen);
1173                 timersub(&tv, &tvlen, tvp);
1174                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1175                         tvp->tv_sec = 0;
1176                         tvp->tv_usec = 0;
1177                 }
1178                 return res;
1179         }
1180         else
1181                 return select(nfds, rfds, wfds, efds, NULL);
1182 #endif
1183 }
1184
1185 #ifdef DO_CRASH
1186 #define CRASH do { fprintf(stderr, "!! Forcing immediate crash a-la abort !!\n"); *((int *)0) = 0; } while(0)
1187 #else
1188 #define CRASH do { } while(0)
1189 #endif
1190
1191 #define CHECK_BLOCKING(c) {      \
1192                                                         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1193                                                                 ast_log(LOG_WARNING, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), (c)->name, (long) (c)->blocker, (c)->blockproc); \
1194                                                                 CRASH; \
1195                                                         } else { \
1196                                                                 (c)->blocker = pthread_self(); \
1197                                                                 (c)->blockproc = __PRETTY_FUNCTION__; \
1198                                                                         ast_set_flag(c, AST_FLAG_BLOCKING); \
1199                                                                         } }
1200
1201 extern ast_group_t ast_get_group(char *s);
1202
1203 /*! \brief print call- and pickup groups into buffer */
1204 extern char *ast_print_group(char *buf, int buflen, ast_group_t group);
1205
1206 /*! \brief Convert enum channelreloadreason to text string for manager event
1207         \param reason   Enum channelreloadreason - reason for reload (manager, cli, start etc)
1208 */
1209 const char *channelreloadreason2txt(enum channelreloadreason reason);
1210
1211 #if defined(__cplusplus) || defined(c_plusplus)
1212 }
1213 #endif
1214
1215 #endif /* _ASTERISK_CHANNEL_H */