]> git.sesse.net Git - vlc/blob - src/control/media.c
Remove some exceptions in media_list
[vlc] / src / control / media.c
1 /*****************************************************************************
2  * media.c: Libvlc API media descripor management
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Pierre d'Herbemont <pdherbemont@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <assert.h>
29
30 #include <vlc/libvlc.h>
31 #include <vlc/libvlc_media.h>
32 #include <vlc/libvlc_media_list.h> // For the subitems, here for convenience
33 #include <vlc/libvlc_events.h>
34
35 #include <vlc_common.h>
36 #include <vlc_input.h>
37 #include <vlc_meta.h>
38 #include <vlc_playlist.h> /* For the preparser */
39
40 #include "libvlc.h"
41
42 #include "libvlc_internal.h"
43 #include "media_internal.h"
44
45 static const vlc_meta_type_t libvlc_to_vlc_meta[] =
46 {
47     [libvlc_meta_Title]        = vlc_meta_Title,
48     [libvlc_meta_Artist]       = vlc_meta_Artist,
49     [libvlc_meta_Genre]        = vlc_meta_Genre,
50     [libvlc_meta_Copyright]    = vlc_meta_Copyright,
51     [libvlc_meta_Album]        = vlc_meta_Album,
52     [libvlc_meta_TrackNumber]  = vlc_meta_TrackNumber,
53     [libvlc_meta_Description]  = vlc_meta_Description,
54     [libvlc_meta_Rating]       = vlc_meta_Rating,
55     [libvlc_meta_Date]         = vlc_meta_Date,
56     [libvlc_meta_Setting]      = vlc_meta_Setting,
57     [libvlc_meta_URL]          = vlc_meta_URL,
58     [libvlc_meta_Language]     = vlc_meta_Language,
59     [libvlc_meta_NowPlaying]   = vlc_meta_NowPlaying,
60     [libvlc_meta_Publisher]    = vlc_meta_Publisher,
61     [libvlc_meta_EncodedBy]    = vlc_meta_EncodedBy,
62     [libvlc_meta_ArtworkURL]   = vlc_meta_ArtworkURL,
63     [libvlc_meta_TrackID]      = vlc_meta_TrackID
64 };
65
66 static const libvlc_meta_t vlc_to_libvlc_meta[] =
67 {
68     [vlc_meta_Title]        = libvlc_meta_Title,
69     [vlc_meta_Artist]       = libvlc_meta_Artist,
70     [vlc_meta_Genre]        = libvlc_meta_Genre,
71     [vlc_meta_Copyright]    = libvlc_meta_Copyright,
72     [vlc_meta_Album]        = libvlc_meta_Album,
73     [vlc_meta_TrackNumber]  = libvlc_meta_TrackNumber,
74     [vlc_meta_Description]  = libvlc_meta_Description,
75     [vlc_meta_Rating]       = libvlc_meta_Rating,
76     [vlc_meta_Date]         = libvlc_meta_Date,
77     [vlc_meta_Setting]      = libvlc_meta_Setting,
78     [vlc_meta_URL]          = libvlc_meta_URL,
79     [vlc_meta_Language]     = libvlc_meta_Language,
80     [vlc_meta_NowPlaying]   = libvlc_meta_NowPlaying,
81     [vlc_meta_Publisher]    = libvlc_meta_Publisher,
82     [vlc_meta_EncodedBy]    = libvlc_meta_EncodedBy,
83     [vlc_meta_ArtworkURL]   = libvlc_meta_ArtworkURL,
84     [vlc_meta_TrackID]      = libvlc_meta_TrackID
85 };
86
87 /**************************************************************************
88  * input_item_subitem_added (Private) (vlc event Callback)
89  **************************************************************************/
90 static void input_item_subitem_added( const vlc_event_t *p_event,
91                                        void * user_data )
92 {
93     libvlc_media_t * p_md = user_data;
94     libvlc_media_t * p_md_child;
95     libvlc_event_t event;
96
97     p_md_child = libvlc_media_new_from_input_item(
98                 p_md->p_libvlc_instance,
99                 p_event->u.input_item_subitem_added.p_new_child );
100
101     /* Add this to our media list */
102     if( !p_md->p_subitems )
103     {
104         p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance );
105         libvlc_media_list_set_media( p_md->p_subitems, p_md );
106     }
107     if( p_md->p_subitems )
108     {
109         libvlc_media_list_add_media( p_md->p_subitems, p_md_child );
110     }
111
112     /* Construct the event */
113     event.type = libvlc_MediaSubItemAdded;
114     event.u.media_subitem_added.new_child = p_md_child;
115
116     /* Send the event */
117     libvlc_event_send( p_md->p_event_manager, &event );
118     libvlc_media_release( p_md_child );
119 }
120
121 /**************************************************************************
122  * input_item_meta_changed (Private) (vlc event Callback)
123  **************************************************************************/
124 static void input_item_meta_changed( const vlc_event_t *p_event,
125                                      void * user_data )
126 {
127     libvlc_media_t * p_md = user_data;
128     libvlc_event_t event;
129
130     /* Construct the event */
131     event.type = libvlc_MediaMetaChanged;
132     event.u.media_meta_changed.meta_type =
133         vlc_to_libvlc_meta[p_event->u.input_item_meta_changed.meta_type];
134
135     /* Send the event */
136     libvlc_event_send( p_md->p_event_manager, &event );
137 }
138
139 /**************************************************************************
140  * input_item_duration_changed (Private) (vlc event Callback)
141  **************************************************************************/
142 static void input_item_duration_changed( const vlc_event_t *p_event,
143                                          void * user_data )
144 {
145     libvlc_media_t * p_md = user_data;
146     libvlc_event_t event;
147
148     /* Construct the event */
149     event.type = libvlc_MediaDurationChanged;
150     event.u.media_duration_changed.new_duration =
151         from_mtime(p_event->u.input_item_duration_changed.new_duration);
152
153     /* Send the event */
154     libvlc_event_send( p_md->p_event_manager, &event );
155 }
156
157 /**************************************************************************
158  * input_item_preparsed_changed (Private) (vlc event Callback)
159  **************************************************************************/
160 static void input_item_preparsed_changed( const vlc_event_t *p_event,
161                                           void * user_data )
162 {
163     libvlc_media_t * p_md = user_data;
164     libvlc_event_t event;
165
166     /* Construct the event */
167     event.type = libvlc_MediaPreparsedChanged;
168     event.u.media_preparsed_changed.new_status = 
169         p_event->u.input_item_preparsed_changed.new_status;
170
171     /* Send the event */
172     libvlc_event_send( p_md->p_event_manager, &event );
173 }
174
175 /**************************************************************************
176  * Install event handler (Private)
177  **************************************************************************/
178 static void install_input_item_observer( libvlc_media_t *p_md )
179 {
180     vlc_event_attach( &p_md->p_input_item->event_manager,
181                       vlc_InputItemSubItemAdded,
182                       input_item_subitem_added,
183                       p_md );
184     vlc_event_attach( &p_md->p_input_item->event_manager,
185                       vlc_InputItemMetaChanged,
186                       input_item_meta_changed,
187                       p_md );
188     vlc_event_attach( &p_md->p_input_item->event_manager,
189                       vlc_InputItemDurationChanged,
190                       input_item_duration_changed,
191                       p_md );
192     vlc_event_attach( &p_md->p_input_item->event_manager,
193                       vlc_InputItemPreparsedChanged,
194                       input_item_preparsed_changed,
195                       p_md );
196 }
197
198 /**************************************************************************
199  * Uninstall event handler (Private)
200  **************************************************************************/
201 static void uninstall_input_item_observer( libvlc_media_t *p_md )
202 {
203     vlc_event_detach( &p_md->p_input_item->event_manager,
204                       vlc_InputItemSubItemAdded,
205                       input_item_subitem_added,
206                       p_md );
207     vlc_event_detach( &p_md->p_input_item->event_manager,
208                       vlc_InputItemMetaChanged,
209                       input_item_meta_changed,
210                       p_md );
211     vlc_event_detach( &p_md->p_input_item->event_manager,
212                       vlc_InputItemDurationChanged,
213                       input_item_duration_changed,
214                       p_md );
215     vlc_event_detach( &p_md->p_input_item->event_manager,
216                       vlc_InputItemPreparsedChanged,
217                       input_item_preparsed_changed,
218                       p_md );
219 }
220
221 /**************************************************************************
222  * Preparse if not already done (Private)
223  **************************************************************************/
224 static void preparse_if_needed( libvlc_media_t *p_md )
225 {
226     /* XXX: need some locking here */
227     if (!p_md->b_preparsed)
228     {
229         playlist_PreparseEnqueue(
230                 libvlc_priv (p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
231                 p_md->p_input_item, pl_Unlocked );
232         p_md->b_preparsed = true;
233     }
234 }
235
236 /**************************************************************************
237  * Create a new media descriptor object from an input_item
238  * (libvlc internal)
239  * That's the generic constructor
240  **************************************************************************/
241 libvlc_media_t * libvlc_media_new_from_input_item(
242                                    libvlc_instance_t *p_instance,
243                                    input_item_t *p_input_item )
244 {
245     libvlc_media_t * p_md;
246
247     if (!p_input_item)
248     {
249         libvlc_printerr( "No input item given" );
250         return NULL;
251     }
252
253     p_md = calloc( 1, sizeof(libvlc_media_t) );
254     if( !p_md )
255     {
256         libvlc_printerr( "Not enough memory" );
257         return NULL;
258     }
259
260     p_md->p_libvlc_instance = p_instance;
261     p_md->p_input_item      = p_input_item;
262     p_md->i_refcount        = 1;
263
264     p_md->state = libvlc_NothingSpecial;
265
266     /* A media descriptor can be a playlist. When you open a playlist
267      * It can give a bunch of item to read. */
268     p_md->p_subitems        = NULL;
269
270     p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance );
271     if( unlikely(p_md->p_event_manager == NULL) )
272     {
273         free(p_md);
274         return NULL;
275     }
276     libvlc_event_manager_register_event_type( p_md->p_event_manager,
277         libvlc_MediaMetaChanged );
278     libvlc_event_manager_register_event_type( p_md->p_event_manager,
279         libvlc_MediaSubItemAdded );
280     libvlc_event_manager_register_event_type( p_md->p_event_manager,
281         libvlc_MediaFreed );
282     libvlc_event_manager_register_event_type( p_md->p_event_manager,
283         libvlc_MediaDurationChanged );
284     libvlc_event_manager_register_event_type( p_md->p_event_manager,
285         libvlc_MediaStateChanged );
286
287     vlc_gc_incref( p_md->p_input_item );
288
289     install_input_item_observer( p_md );
290
291     return p_md;
292 }
293
294 /**************************************************************************
295  * Create a new media descriptor object
296  **************************************************************************/
297 libvlc_media_t * libvlc_media_new( libvlc_instance_t *p_instance,
298                                    const char * psz_mrl )
299 {
300     input_item_t * p_input_item;
301     libvlc_media_t * p_md;
302
303     p_input_item = input_item_New( p_instance->p_libvlc_int, psz_mrl, NULL );
304
305     if (!p_input_item)
306     {
307         libvlc_printerr( "Not enough memory" );
308         return NULL;
309     }
310
311     p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
312
313     /* The p_input_item is retained in libvlc_media_new_from_input_item */
314     vlc_gc_decref( p_input_item );
315
316     return p_md;
317 }
318
319 /**************************************************************************
320  * Create a new media descriptor object
321  **************************************************************************/
322 libvlc_media_t * libvlc_media_new_as_node( libvlc_instance_t *p_instance,
323                                            const char * psz_name )
324 {
325     input_item_t * p_input_item;
326     libvlc_media_t * p_md;
327
328     p_input_item = input_item_New( p_instance->p_libvlc_int, "vlc://nop", psz_name );
329
330     if (!p_input_item)
331     {
332         libvlc_printerr( "Not enough memory" );
333         return NULL;
334     }
335
336     p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
337
338     p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance );
339
340     return p_md;
341 }
342
343 /**************************************************************************
344  * Add an option to the media descriptor,
345  * that will be used to determine how the media_player will read the
346  * media. This allow to use VLC advanced reading/streaming
347  * options in a per-media basis
348  *
349  * The options are detailled in vlc --long-help, for instance "--sout-all"
350  **************************************************************************/
351 void libvlc_media_add_option(
352                                    libvlc_media_t * p_md,
353                                    const char * psz_option )
354 {
355     input_item_AddOption( p_md->p_input_item, psz_option,
356                           VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
357 }
358
359 /**************************************************************************
360  * Same as libvlc_media_add_option but with configurable flags.
361  **************************************************************************/
362 void libvlc_media_add_option_flag(
363                                    libvlc_media_t * p_md,
364                                    const char * ppsz_option,
365                                    libvlc_media_option_t i_flags )
366 {
367     input_item_AddOption( p_md->p_input_item, ppsz_option,
368                           i_flags );
369 }
370
371 /**************************************************************************
372  * Delete a media descriptor object
373  **************************************************************************/
374 void libvlc_media_release( libvlc_media_t *p_md )
375 {
376     if (!p_md)
377         return;
378
379     p_md->i_refcount--;
380
381     if( p_md->i_refcount > 0 )
382         return;
383
384     if( p_md->p_subitems )
385         libvlc_media_list_release( p_md->p_subitems );
386
387     uninstall_input_item_observer( p_md );
388     vlc_gc_decref( p_md->p_input_item );
389
390     /* Construct the event */
391     libvlc_event_t event;
392     event.type = libvlc_MediaFreed;
393     event.u.media_freed.md = p_md;
394
395     /* Send the event */
396     libvlc_event_send( p_md->p_event_manager, &event );
397
398     libvlc_event_manager_release( p_md->p_event_manager );
399
400     free( p_md );
401 }
402
403 /**************************************************************************
404  * Retain a media descriptor object
405  **************************************************************************/
406 void libvlc_media_retain( libvlc_media_t *p_md )
407 {
408     assert (p_md);
409     p_md->i_refcount++;
410 }
411
412 /**************************************************************************
413  * Duplicate a media descriptor object
414  **************************************************************************/
415 libvlc_media_t *
416 libvlc_media_duplicate( libvlc_media_t *p_md_orig )
417 {
418     return libvlc_media_new_from_input_item(
419         p_md_orig->p_libvlc_instance, p_md_orig->p_input_item );
420 }
421
422 /**************************************************************************
423  * Get mrl from a media descriptor object
424  **************************************************************************/
425 char *
426 libvlc_media_get_mrl( libvlc_media_t * p_md )
427 {
428     assert( p_md );
429     return input_item_GetURI( p_md->p_input_item );
430 }
431
432 /**************************************************************************
433  * Getter for meta information
434  **************************************************************************/
435
436 char *libvlc_media_get_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta )
437 {
438     char * psz_meta;
439
440     assert( p_md );
441     /* XXX: locking */
442
443     preparse_if_needed( p_md );
444
445     psz_meta = input_item_GetMeta( p_md->p_input_item,
446                                    libvlc_to_vlc_meta[e_meta] );
447
448     if( e_meta == libvlc_meta_ArtworkURL && !psz_meta && !p_md->has_asked_art )
449     {
450         p_md->has_asked_art = true;
451         playlist_AskForArtEnqueue(
452                 libvlc_priv(p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
453                 p_md->p_input_item, pl_Unlocked );
454     }
455
456     /* Should be integrated in core */
457     if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
458     {
459         free( psz_meta );
460         return strdup( p_md->p_input_item->psz_name );
461     }
462
463     return psz_meta;
464 }
465
466 /**************************************************************************
467  * Setter for meta information
468  **************************************************************************/
469
470 void libvlc_media_set_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta, const char *psz_value )
471 {
472     assert( p_md );
473     input_item_SetMeta( p_md->p_input_item, libvlc_to_vlc_meta[e_meta], psz_value );
474 }
475
476 int libvlc_media_save_meta( libvlc_media_t *p_md )
477 {
478     assert( p_md );
479     vlc_object_t *p_obj = VLC_OBJECT(libvlc_priv(
480                             p_md->p_libvlc_instance->p_libvlc_int)->p_playlist);
481     return input_item_WriteMeta( p_obj, p_md->p_input_item ) == VLC_SUCCESS;
482 }
483
484 /**************************************************************************
485  * Getter for state information
486  * Can be error, playing, buffering, NothingSpecial.
487  **************************************************************************/
488
489 libvlc_state_t
490 libvlc_media_get_state( libvlc_media_t *p_md )
491 {
492     assert( p_md );
493     return p_md->state;
494 }
495
496 /**************************************************************************
497  * Setter for state information (LibVLC Internal)
498  **************************************************************************/
499
500 void
501 libvlc_media_set_state( libvlc_media_t *p_md,
502                                    libvlc_state_t state )
503 {
504     libvlc_event_t event;
505
506     p_md->state = state;
507
508     /* Construct the event */
509     event.type = libvlc_MediaStateChanged;
510     event.u.media_state_changed.new_state = state;
511
512     /* Send the event */
513     libvlc_event_send( p_md->p_event_manager, &event );
514 }
515
516 /**************************************************************************
517  * subitems
518  **************************************************************************/
519 libvlc_media_list_t *
520 libvlc_media_subitems( libvlc_media_t * p_md )
521 {
522     if( p_md->p_subitems )
523         libvlc_media_list_retain( p_md->p_subitems );
524     return p_md->p_subitems;
525 }
526
527 /**************************************************************************
528  * Getter for statistics information
529  **************************************************************************/
530 int libvlc_media_get_stats( libvlc_media_t *p_md,
531                             libvlc_media_stats_t *p_stats )
532 {
533     if( !p_md->p_input_item )
534         return false;
535
536     input_stats_t *p_itm_stats = p_md->p_input_item->p_stats;
537     vlc_mutex_lock( &p_itm_stats->lock );
538     p_stats->i_read_bytes = p_itm_stats->i_read_bytes;
539     p_stats->f_input_bitrate = p_itm_stats->f_input_bitrate;
540
541     p_stats->i_demux_read_bytes = p_itm_stats->i_demux_read_bytes;
542     p_stats->f_demux_bitrate = p_itm_stats->f_demux_bitrate;
543     p_stats->i_demux_corrupted = p_itm_stats->i_demux_corrupted;
544     p_stats->i_demux_discontinuity = p_itm_stats->i_demux_discontinuity;
545
546     p_stats->i_decoded_video = p_itm_stats->i_decoded_video;
547     p_stats->i_decoded_audio = p_itm_stats->i_decoded_audio;
548
549     p_stats->i_displayed_pictures = p_itm_stats->i_displayed_pictures;
550     p_stats->i_lost_pictures = p_itm_stats->i_lost_pictures;
551
552     p_stats->i_played_abuffers = p_itm_stats->i_played_abuffers;
553     p_stats->i_lost_abuffers = p_itm_stats->i_lost_abuffers;
554
555     p_stats->i_sent_packets = p_itm_stats->i_sent_packets;
556     p_stats->i_sent_bytes = p_itm_stats->i_sent_bytes;
557     p_stats->f_send_bitrate = p_itm_stats->f_send_bitrate;
558     vlc_mutex_unlock( &p_itm_stats->lock );
559     return true;
560 }
561
562 /**************************************************************************
563  * event_manager
564  **************************************************************************/
565 libvlc_event_manager_t *
566 libvlc_media_event_manager( libvlc_media_t * p_md )
567 {
568     assert( p_md );
569
570     return p_md->p_event_manager;
571 }
572
573 /**************************************************************************
574  * Get duration of media object (in ms)
575  **************************************************************************/
576 int64_t
577 libvlc_media_get_duration( libvlc_media_t * p_md )
578 {
579     assert( p_md );
580
581     if( !p_md->p_input_item )
582     {
583         libvlc_printerr( "No input item" );
584         return -1;
585     }
586
587     preparse_if_needed( p_md );
588
589     if (!input_item_IsPreparsed( p_md->p_input_item ))
590         return -1;
591
592     return from_mtime(input_item_GetDuration( p_md->p_input_item ));
593 }
594
595 /**************************************************************************
596  * Get preparsed status for media object.
597  **************************************************************************/
598 int
599 libvlc_media_is_preparsed( libvlc_media_t * p_md )
600 {
601     assert( p_md );
602
603     if( !p_md->p_input_item )
604         return false;
605
606     return input_item_IsPreparsed( p_md->p_input_item );
607 }
608
609 /**************************************************************************
610  * Sets media descriptor's user_data. user_data is specialized data 
611  * accessed by the host application, VLC.framework uses it as a pointer to 
612  * an native object that references a libvlc_media_t pointer
613  **************************************************************************/
614 void 
615 libvlc_media_set_user_data( libvlc_media_t * p_md, void * p_new_user_data )
616 {
617     assert( p_md );
618     p_md->p_user_data = p_new_user_data;
619 }
620
621 /**************************************************************************
622  * Get media descriptor's user_data. user_data is specialized data 
623  * accessed by the host application, VLC.framework uses it as a pointer to 
624  * an native object that references a libvlc_media_t pointer
625  **************************************************************************/
626 void *
627 libvlc_media_get_user_data( libvlc_media_t * p_md )
628 {
629     assert( p_md );
630     return p_md->p_user_data;
631 }
632
633 /**************************************************************************
634  * Get media descriptor's elementary streams description
635  **************************************************************************/
636 int
637 libvlc_media_get_es( libvlc_media_t *p_md, libvlc_media_es_t ** pp_es )
638 {
639     assert( p_md );
640
641     input_item_t *p_input_item = p_md->p_input_item;
642     vlc_mutex_lock( &p_input_item->lock );
643
644     const int i_es = p_input_item->i_es;
645     *pp_es = (i_es > 0) ? malloc( i_es * sizeof(libvlc_media_es_t) ) : NULL;
646
647     if( !pp_es ) /* no ES, or OOM */
648     {
649         vlc_mutex_unlock( &p_input_item->lock );
650         return 0;
651     }
652
653     /* Fill array */
654     for( int i = 0; i < i_es; i++ )
655     {
656         libvlc_media_es_t *p_mes = *pp_es+i;
657         const es_format_t *p_es = p_input_item->es[i];
658
659         p_mes->i_channels = p_mes->i_rate = 0;
660         p_mes->i_width = p_mes->i_height = 0;
661
662
663         p_mes->i_codec = p_es->i_codec;
664         p_mes->i_id = p_es->i_id;
665
666         p_mes->i_profile = p_es->i_profile;
667         p_mes->i_level = p_es->i_level;
668
669         switch(p_es->i_cat)
670         {
671         case UNKNOWN_ES:
672         default:
673             p_mes->i_type = libvlc_es_unknown;
674             break;
675         case VIDEO_ES:
676             p_mes->i_type = libvlc_es_video;
677             p_mes->i_height = p_es->video.i_height;
678             p_mes->i_width = p_es->video.i_width;
679             break;
680         case AUDIO_ES:
681             p_mes->i_type = libvlc_es_audio;
682             p_mes->i_channels = p_es->audio.i_channels;
683             p_mes->i_rate = p_es->audio.i_rate;
684             break;
685         case SPU_ES:
686             p_mes->i_type = libvlc_es_text;
687             break;
688         }
689     }
690
691     vlc_mutex_unlock( &p_input_item->lock );
692     return i_es;
693 }