vout.m 38.9 KB
Newer Older
1
2
3
/*****************************************************************************
 * vout.m: MacOS X video output plugin
 *****************************************************************************
4
 * Copyright (C) 2001-2003 VideoLAN
hartman's avatar
hartman committed
5
 * $Id: vout.m,v 1.45 2003/05/01 01:11:17 hartman Exp $
6
7
8
9
 *
 * Authors: Colin Delacroix <colin@zoy.org>
 *          Florian G. Pflug <fgp@phlo.org>
 *          Jon Lech Johansen <jon-vl@nanocrew.net>
hartman's avatar
hartman committed
10
 *          Derk-Jan Hartman <thedj@users.sourceforge.net>
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <errno.h>                                                 /* ENOMEM */
#include <stdlib.h>                                                /* free() */
#include <string.h>                                            /* strerror() */

#include <QuickTime/QuickTime.h>

#include "intf.h"
#include "vout.h"

#define QT_MAX_DIRECTBUFFERS 10
hartman's avatar
hartman committed
40
#define VL_MAX_DISPLAYS 16
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

struct picture_sys_t
{
    void *p_info;
    unsigned int i_size;

    /* When using I420 output */
    PlanarPixmapInfoYUV420 pixmap_i420;
};

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static int  vout_Init      ( vout_thread_t * );
static void vout_End       ( vout_thread_t * );
static int  vout_Manage    ( vout_thread_t * );
static void vout_Display   ( vout_thread_t *, picture_t * );

59
static int  CoSendRequest      ( vout_thread_t *, SEL );
60
61
62
63
static int  CoCreateWindow     ( vout_thread_t * );
static int  CoDestroyWindow    ( vout_thread_t * );
static int  CoToggleFullscreen ( vout_thread_t * );

hartman's avatar
hartman committed
64
static void VLCHideMouse       ( vout_thread_t *, BOOL );
hartman's avatar
hartman committed
65

66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
static void QTScaleMatrix      ( vout_thread_t * );
static int  QTCreateSequence   ( vout_thread_t * );
static void QTDestroySequence  ( vout_thread_t * );
static int  QTNewPicture       ( vout_thread_t *, picture_t * );
static void QTFreePicture      ( vout_thread_t *, picture_t * );

/*****************************************************************************
 * OpenVideo: allocates MacOS X video thread output method
 *****************************************************************************
 * This function allocates and initializes a MacOS X vout method.
 *****************************************************************************/
int E_(OpenVideo) ( vlc_object_t *p_this )
{   
    vout_thread_t * p_vout = (vout_thread_t *)p_this;
    OSErr err;
81
    int i_timeout;
82
83
84
85
86
87
88
89
90
91

    p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
    if( p_vout->p_sys == NULL )
    {
        msg_Err( p_vout, "out of memory" );
        return( 1 );
    }

    memset( p_vout->p_sys, 0, sizeof( vout_sys_t ) );

92
93
    /* Wait for a MacOS X interface to appear. Timeout is 2 seconds. */
    for( i_timeout = 20 ; i_timeout-- ; )
94
    {
95
        if( NSApp == NULL )
96
97
98
        {
            msleep( INTF_IDLE_SLEEP );
        }
99
100
    }

101
    if( NSApp == NULL )
102
    {
103
104
        /* no MacOS X intf, unable to communicate with MT */
        msg_Err( p_vout, "no MacOS X interface present" );
105
106
107
108
        free( p_vout->p_sys );
        return( 1 );
    }

109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
    if( [NSApp respondsToSelector: @selector(getIntf)] )
    {
        intf_thread_t * p_intf;

        for( i_timeout = 10 ; i_timeout-- ; )
        {
            if( ( p_intf = [NSApp getIntf] ) == NULL )
            {
                msleep( INTF_IDLE_SLEEP );
            }
        }

        if( p_intf == NULL )
        {
            msg_Err( p_vout, "MacOS X intf has getIntf, but is NULL" );
            free( p_vout->p_sys );
            return( 1 );
        }
    }

129
130
131
    p_vout->p_sys->h_img_descr = 
        (ImageDescriptionHandle)NewHandleClear( sizeof(ImageDescription) );
    p_vout->p_sys->p_matrix = (MatrixRecordPtr)malloc( sizeof(MatrixRecord) );
132
    p_vout->p_sys->p_fullscreen_state = NULL;
133

hartman's avatar
hartman committed
134
135
136
    p_vout->p_sys->b_mouse_pointer_visible = YES;
    p_vout->p_sys->b_mouse_moved = YES;
    p_vout->p_sys->i_time_mouse_last_moved = mdate();
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

    /* set window size */
    p_vout->p_sys->s_rect.size.width = p_vout->i_window_width;
    p_vout->p_sys->s_rect.size.height = p_vout->i_window_height;

    if( ( err = EnterMovies() ) != noErr )
    {
        msg_Err( p_vout, "EnterMovies failed: %d", err );
        free( p_vout->p_sys->p_matrix );
        DisposeHandle( (Handle)p_vout->p_sys->h_img_descr );
        free( p_vout->p_sys );
        return( 1 );
    } 

    if( vout_ChromaCmp( p_vout->render.i_chroma, VLC_FOURCC('I','4','2','0') ) )
    {
        err = FindCodec( kYUV420CodecType, bestSpeedCodec,
                         nil, &p_vout->p_sys->img_dc );
        if( err == noErr && p_vout->p_sys->img_dc != 0 )
        {
            p_vout->output.i_chroma = VLC_FOURCC('I','4','2','0');
            p_vout->p_sys->i_codec = kYUV420CodecType;
        }
        else
        {
            msg_Err( p_vout, "failed to find an appropriate codec" );
        }
    }
    else
    {
        msg_Err( p_vout, "chroma 0x%08x not supported",
                         p_vout->render.i_chroma );
    }

    if( p_vout->p_sys->img_dc == 0 )
    {
        free( p_vout->p_sys->p_matrix );
        DisposeHandle( (Handle)p_vout->p_sys->h_img_descr );
        free( p_vout->p_sys );
        return( 1 );        
    }

179
180
    NSAutoreleasePool * o_pool = [[NSAutoreleasePool alloc] init];
    NSArray * o_screens = [NSScreen screens];
181
    if( [o_screens count] > 0 && var_Type( p_vout, "video-device" ) == 0 )
182
    {
183
        int i = 1;
184
        vlc_value_t val;
185
186
        NSScreen * o_screen;

187
188
189
190
        int i_option = config_GetInt( p_vout, "macosx-vdev" );

        var_Create( p_vout, "video-device", VLC_VAR_STRING |
                                            VLC_VAR_HASCHOICE ); 
191
192
193

        NSEnumerator * o_enumerator = [o_screens objectEnumerator];

194
        while( (o_screen = [o_enumerator nextObject]) != NULL )
195
196
        {
            char psz_temp[255];
197
198
199
            NSRect s_rect = [o_screen frame];

            snprintf( psz_temp, sizeof(psz_temp)/sizeof(psz_temp[0])-1, 
200
                      "%s %d (%dx%d)", _("Screen"), i,
201
202
                      (int)s_rect.size.width, (int)s_rect.size.height ); 

203
204
            val.psz_string = psz_temp;
            var_Change( p_vout, "video-device", VLC_VAR_ADDCHOICE, &val );
205

206
207
208
209
210
            if( ( i - 1 ) == i_option )
            {
                var_Set( p_vout, "video-device", val );
            }

211
212
            i++;
        }
213

214
215
216
217
218
219
        var_AddCallback( p_vout, "video-device", vout_VarCallback,
                         NULL );

        val.b_bool = VLC_TRUE;
        var_Set( p_vout, "intf-change", val );
    }
220
    [o_pool release];
221

222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
    if( CoCreateWindow( p_vout ) )
    {
        msg_Err( p_vout, "unable to create window" );
        free( p_vout->p_sys->p_matrix );
        DisposeHandle( (Handle)p_vout->p_sys->h_img_descr );
        free( p_vout->p_sys ); 
        return( 1 );
    }

    p_vout->pf_init = vout_Init;
    p_vout->pf_end = vout_End;
    p_vout->pf_manage = vout_Manage;
    p_vout->pf_render = NULL;
    p_vout->pf_display = vout_Display;

    return( 0 );
}

/*****************************************************************************
 * vout_Init: initialize video thread output method
 *****************************************************************************/
static int vout_Init( vout_thread_t *p_vout )
{
    int i_index;
    picture_t *p_pic;

    I_OUTPUTPICTURES = 0;

    /* Initialize the output structure; we already found a codec,
     * and the corresponding chroma we will be using. Since we can
     * arbitrary scale, stick to the coordinates and aspect. */
    p_vout->output.i_width  = p_vout->render.i_width;
    p_vout->output.i_height = p_vout->render.i_height;
    p_vout->output.i_aspect = p_vout->render.i_aspect;

    SetPort( p_vout->p_sys->p_qdport );
    QTScaleMatrix( p_vout );

    if( QTCreateSequence( p_vout ) )
    {
        msg_Err( p_vout, "unable to create sequence" );
        return( 1 );
    }

    /* Try to initialize up to QT_MAX_DIRECTBUFFERS direct buffers */
    while( I_OUTPUTPICTURES < QT_MAX_DIRECTBUFFERS )
    {
        p_pic = NULL;

        /* Find an empty picture slot */
        for( i_index = 0; i_index < VOUT_MAX_PICTURES; i_index++ )
        {
            if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
            {
                p_pic = p_vout->p_picture + i_index;
                break;
            }
        }

        /* Allocate the picture */
        if( p_pic == NULL || QTNewPicture( p_vout, p_pic ) )
        {
            break;
        }

        p_pic->i_status = DESTROYED_PICTURE;
        p_pic->i_type   = DIRECT_PICTURE;

        PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;

        I_OUTPUTPICTURES++;
    }

    return( 0 );
}

/*****************************************************************************
 * vout_End: terminate video thread output method
 *****************************************************************************/
static void vout_End( vout_thread_t *p_vout )
{
    int i_index;

    QTDestroySequence( p_vout );

    /* Free the direct buffers we allocated */
    for( i_index = I_OUTPUTPICTURES; i_index; )
    {
        i_index--;
        QTFreePicture( p_vout, PP_OUTPUTPICTURE[ i_index ] );
    }
}

/*****************************************************************************
 * CloseVideo: destroy video thread output method
 *****************************************************************************/
void E_(CloseVideo) ( vlc_object_t *p_this )
{       
    vout_thread_t * p_vout = (vout_thread_t *)p_this;     

    if( CoDestroyWindow( p_vout ) )
    {
        msg_Err( p_vout, "unable to destroy window" );
    }

327
328
329
    if ( p_vout->p_sys->p_fullscreen_state != NULL )
        EndFullScreen ( p_vout->p_sys->p_fullscreen_state, NULL );

330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
    ExitMovies();

    free( p_vout->p_sys->p_matrix );
    DisposeHandle( (Handle)p_vout->p_sys->h_img_descr );

    free( p_vout->p_sys );
}

/*****************************************************************************
 * vout_Manage: handle events
 *****************************************************************************
 * This function should be called regularly by video output thread. It manages
 * console events. It returns a non null value on error.
 *****************************************************************************/
static int vout_Manage( vout_thread_t *p_vout )
hartman's avatar
hartman committed
345
{
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
    if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
    {
        if( CoToggleFullscreen( p_vout ) )  
        {
            return( 1 );
        }

        p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
    }

    if( p_vout->i_changes & VOUT_SIZE_CHANGE ) 
    {
        QTScaleMatrix( p_vout );
        SetDSequenceMatrix( p_vout->p_sys->i_seq, 
                            p_vout->p_sys->p_matrix );
 
        p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
    }

hartman's avatar
hartman committed
365
366
367
368
    /* hide/show mouse cursor 
     * this code looks unnecessarily complicated, but is necessary like this.
     * it has to deal with multiple monitors and therefore checks a lot */
    if( !p_vout->p_sys->b_mouse_moved && p_vout->b_fullscreen )
369
    {
hartman's avatar
hartman committed
370
        if( mdate() - p_vout->p_sys->i_time_mouse_last_moved > 2000000 && 
371
                   p_vout->p_sys->b_mouse_pointer_visible )
372
        {
hartman's avatar
hartman committed
373
            VLCHideMouse( p_vout, YES );
374
        }
hartman's avatar
hartman committed
375
376
377
378
379
        else if ( !p_vout->p_sys->b_mouse_pointer_visible )
        {
            vlc_bool_t b_playing = NO;
            playlist_t * p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
                                                                    FIND_ANYWHERE );
380

hartman's avatar
hartman committed
381
382
383
384
385
386
387
388
389
390
391
392
            if ( p_playlist != nil )
            {
                vlc_mutex_lock( &p_playlist->object_lock );
                if( p_playlist->p_input != NULL )
                {
                    vlc_mutex_lock( &p_playlist->p_input->stream.stream_lock );
                    b_playing = p_playlist->p_input->stream.control.i_status != PAUSE_S;
                    vlc_mutex_unlock( &p_playlist->p_input->stream.stream_lock );
                }
                vlc_mutex_unlock( &p_playlist->object_lock );
                vlc_object_release( p_playlist );
            }
hartman's avatar
hartman committed
393
            if ( !b_playing )
hartman's avatar
hartman committed
394
395
396
397
            {
                VLCHideMouse( p_vout, NO );
            }
        }
398
    }
hartman's avatar
hartman committed
399
    else if ( p_vout->p_sys->b_mouse_moved && p_vout->b_fullscreen )
400
401
    {
        if( !p_vout->p_sys->b_mouse_pointer_visible )
402
        {
hartman's avatar
hartman committed
403
            VLCHideMouse( p_vout, NO );
404
        }
hartman's avatar
hartman committed
405
        else
406
        {
hartman's avatar
hartman committed
407
            p_vout->p_sys->b_mouse_moved = NO;
408
409
        }
    }
410
    
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
    return( 0 );
}

/*****************************************************************************
 * vout_Display: displays previously rendered output
 *****************************************************************************
 * This function sends the currently rendered image to the display.
 *****************************************************************************/
static void vout_Display( vout_thread_t *p_vout, picture_t *p_pic )
{
    OSErr err;
    CodecFlags flags;

    if( ( err = DecompressSequenceFrameS( 
                    p_vout->p_sys->i_seq,
                    p_pic->p_sys->p_info,
                    p_pic->p_sys->i_size,                    
                    codecFlagUseImageBuffer, &flags, nil ) != noErr ) )
    {
430
        msg_Warn( p_vout, "DecompressSequenceFrameS failed: %d", err );
431
432
433
434
435
436
437
438
439
440
441
442
    }
    else
    {
        QDFlushPortBuffer( p_vout->p_sys->p_qdport, nil );
    }
}

/*****************************************************************************
 * CoSendRequest: send request to interface thread
 *****************************************************************************
 * Returns 0 on success, 1 otherwise
 *****************************************************************************/
443
static int CoSendRequest( vout_thread_t *p_vout, SEL sel )
444
{
445
    int i_ret = 0;
446

447
    VLCVout * o_vlv = [[VLCVout alloc] init];
448

449
    if( ( i_ret = ExecuteOnMainThread( o_vlv, sel, (void *)p_vout ) ) )
450
451
452
    {
        msg_Err( p_vout, "SendRequest: no way to communicate with mt" );
    }
453

454
    [o_vlv release];
455

456
    return( i_ret );
457
458
459
460
461
462
463
464
465
}

/*****************************************************************************
 * CoCreateWindow: create new window 
 *****************************************************************************
 * Returns 0 on success, 1 otherwise
 *****************************************************************************/
static int CoCreateWindow( vout_thread_t *p_vout )
{
466
    if( CoSendRequest( p_vout, @selector(createWindow:) ) )
467
    {
468
        msg_Err( p_vout, "CoSendRequest (createWindow) failed" );
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
        return( 1 );
    }

    return( 0 );
}

/*****************************************************************************
 * CoDestroyWindow: destroy window 
 *****************************************************************************
 * Returns 0 on success, 1 otherwise
 *****************************************************************************/
static int CoDestroyWindow( vout_thread_t *p_vout )
{
    if( !p_vout->p_sys->b_mouse_pointer_visible )
    {
hartman's avatar
hartman committed
484
        VLCHideMouse( p_vout, NO );
485
486
    }

487
    if( CoSendRequest( p_vout, @selector(destroyWindow:) ) )
488
    {
489
        msg_Err( p_vout, "CoSendRequest (destroyWindow) failed" );
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
        return( 1 );
    }

    return( 0 );
}

/*****************************************************************************
 * CoToggleFullscreen: toggle fullscreen 
 *****************************************************************************
 * Returns 0 on success, 1 otherwise
 *****************************************************************************/
static int CoToggleFullscreen( vout_thread_t *p_vout )
{
    QTDestroySequence( p_vout );

    if( CoDestroyWindow( p_vout ) )
    {
        msg_Err( p_vout, "unable to destroy window" );
        return( 1 );
    }
    
    p_vout->b_fullscreen = !p_vout->b_fullscreen;

Christophe Massiot's avatar
Christophe Massiot committed
513
    config_PutInt( p_vout, "fullscreen", p_vout->b_fullscreen );
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532

    if( CoCreateWindow( p_vout ) )
    {
        msg_Err( p_vout, "unable to create window" );
        return( 1 );
    }

    SetPort( p_vout->p_sys->p_qdport );
    QTScaleMatrix( p_vout );

    if( QTCreateSequence( p_vout ) )
    {
        msg_Err( p_vout, "unable to create sequence" );
        return( 1 ); 
    } 

    return( 0 );
}

hartman's avatar
hartman committed
533
/*****************************************************************************
hartman's avatar
hartman committed
534
 * VLCHideMouse: if b_hide then hide the cursor
hartman's avatar
hartman committed
535
 *****************************************************************************/
hartman's avatar
hartman committed
536
static void VLCHideMouse ( vout_thread_t *p_vout, BOOL b_hide )
hartman's avatar
hartman committed
537
{
hartman's avatar
hartman committed
538
539
540
541
542
    BOOL b_inside;
    NSRect s_rect;
    NSPoint ml;
    NSWindow *o_window = p_vout->p_sys->o_window;
    NSView *o_contents = [o_window contentView];
hartman's avatar
hartman committed
543
    
hartman's avatar
hartman committed
544
545
546
547
    s_rect = [o_contents bounds];
    ml = [o_window convertScreenToBase:[NSEvent mouseLocation]];
    ml = [o_contents convertPoint:ml fromView:nil];
    b_inside = [o_contents mouse: ml inRect: s_rect];
hartman's avatar
hartman committed
548
    
hartman's avatar
hartman committed
549
    if ( b_hide && b_inside )
hartman's avatar
hartman committed
550
    {
hartman's avatar
hartman committed
551
552
553
554
555
556
557
558
        /* only hide if mouse over VLCView */
        [NSCursor hide];
        p_vout->p_sys->b_mouse_pointer_visible = 0;
    }
    else if ( !b_hide )
    {
        [NSCursor unhide];
        p_vout->p_sys->b_mouse_pointer_visible = 1;
hartman's avatar
hartman committed
559
    }
hartman's avatar
hartman committed
560
561
    p_vout->p_sys->b_mouse_moved = NO;
    p_vout->p_sys->i_time_mouse_last_moved = mdate();
hartman's avatar
hartman committed
562
563
564
    return;
}

565
566
567
568
569
570
/*****************************************************************************
 * QTScaleMatrix: scale matrix 
 *****************************************************************************/
static void QTScaleMatrix( vout_thread_t *p_vout )
{
    Rect s_rect;
571
    unsigned int i_width, i_height;
572
    Fixed factor_x, factor_y;
573
574
    unsigned int i_offset_x = 0;
    unsigned int i_offset_y = 0;
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604

    GetPortBounds( p_vout->p_sys->p_qdport, &s_rect );

    i_width = s_rect.right - s_rect.left;
    i_height = s_rect.bottom - s_rect.top;

    if( i_height * p_vout->output.i_aspect < i_width * VOUT_ASPECT_FACTOR )
    {
        int i_adj_width = i_height * p_vout->output.i_aspect /
                          VOUT_ASPECT_FACTOR;

        factor_x = FixDiv( Long2Fix( i_adj_width ),
                           Long2Fix( p_vout->output.i_width ) );
        factor_y = FixDiv( Long2Fix( i_height ),
                           Long2Fix( p_vout->output.i_height ) );

        i_offset_x = (i_width - i_adj_width) / 2;
    }
    else
    {
        int i_adj_height = i_width * VOUT_ASPECT_FACTOR /
                           p_vout->output.i_aspect;

        factor_x = FixDiv( Long2Fix( i_width ),
                           Long2Fix( p_vout->output.i_width ) );
        factor_y = FixDiv( Long2Fix( i_adj_height ),
                           Long2Fix( p_vout->output.i_height ) );

        i_offset_y = (i_height - i_adj_height) / 2;
    }
605
    
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
    SetIdentityMatrix( p_vout->p_sys->p_matrix );

    ScaleMatrix( p_vout->p_sys->p_matrix,
                 factor_x, factor_y,
                 Long2Fix(0), Long2Fix(0) );            

    TranslateMatrix( p_vout->p_sys->p_matrix, 
                     Long2Fix(i_offset_x), 
                     Long2Fix(i_offset_y) );
}

/*****************************************************************************
 * QTCreateSequence: create a new sequence 
 *****************************************************************************
 * Returns 0 on success, 1 otherwise
 *****************************************************************************/
static int QTCreateSequence( vout_thread_t *p_vout )
{
    OSErr err;
    ImageDescriptionPtr p_descr;

    HLock( (Handle)p_vout->p_sys->h_img_descr );
    p_descr = *p_vout->p_sys->h_img_descr;

    p_descr->idSize = sizeof(ImageDescription);
    p_descr->cType = p_vout->p_sys->i_codec;
    p_descr->version = 1;
    p_descr->revisionLevel = 0;
    p_descr->vendor = 'appl';
    p_descr->width = p_vout->output.i_width;
    p_descr->height = p_vout->output.i_height;
    p_descr->hRes = Long2Fix(72);
    p_descr->vRes = Long2Fix(72);
    p_descr->spatialQuality = codecLosslessQuality;
    p_descr->frameCount = 1;
    p_descr->clutID = -1;
    p_descr->dataSize = 0;
    p_descr->depth = 24;

    HUnlock( (Handle)p_vout->p_sys->h_img_descr );

    if( ( err = DecompressSequenceBeginS( 
                              &p_vout->p_sys->i_seq,
                              p_vout->p_sys->h_img_descr,
                              NULL, 0,
                              p_vout->p_sys->p_qdport,
                              NULL, NULL,
                              p_vout->p_sys->p_matrix,
                              0, NULL,
                              codecFlagUseImageBuffer,
                              codecLosslessQuality,
                              p_vout->p_sys->img_dc ) ) )
    {
        msg_Err( p_vout, "DecompressSequenceBeginS failed: %d", err );
        return( 1 );
    }

    return( 0 );
}

/*****************************************************************************
 * QTDestroySequence: destroy sequence 
 *****************************************************************************/
static void QTDestroySequence( vout_thread_t *p_vout )
{
    CDSequenceEnd( p_vout->p_sys->i_seq );
}

/*****************************************************************************
 * QTNewPicture: allocate a picture
 *****************************************************************************
 * Returns 0 on success, 1 otherwise
 *****************************************************************************/
static int QTNewPicture( vout_thread_t *p_vout, picture_t *p_pic )
{
    int i_width  = p_vout->output.i_width;
    int i_height = p_vout->output.i_height;

    /* We know the chroma, allocate a buffer which will be used
     * directly by the decoder */
    p_pic->p_sys = malloc( sizeof( picture_sys_t ) );

    if( p_pic->p_sys == NULL )
    {
        return( -1 );
    }

    switch( p_vout->output.i_chroma )
    {
        case VLC_FOURCC('I','4','2','0'):

            p_pic->p_sys->p_info = (void *)&p_pic->p_sys->pixmap_i420;
            p_pic->p_sys->i_size = sizeof(PlanarPixmapInfoYUV420);

            /* Allocate the memory buffer */
            p_pic->p_data = vlc_memalign( &p_pic->p_data_orig,
                                          16, i_width * i_height * 3 / 2 );

            /* Y buffer */
            p_pic->Y_PIXELS = p_pic->p_data; 
            p_pic->p[Y_PLANE].i_lines = i_height;
            p_pic->p[Y_PLANE].i_pitch = i_width;
            p_pic->p[Y_PLANE].i_pixel_pitch = 1;
            p_pic->p[Y_PLANE].i_visible_pitch = i_width;

            /* U buffer */
            p_pic->U_PIXELS = p_pic->Y_PIXELS + i_height * i_width;
            p_pic->p[U_PLANE].i_lines = i_height / 2;
            p_pic->p[U_PLANE].i_pitch = i_width / 2;
            p_pic->p[U_PLANE].i_pixel_pitch = 1;
            p_pic->p[U_PLANE].i_visible_pitch = i_width / 2;

            /* V buffer */
            p_pic->V_PIXELS = p_pic->U_PIXELS + i_height * i_width / 4;
            p_pic->p[V_PLANE].i_lines = i_height / 2;
            p_pic->p[V_PLANE].i_pitch = i_width / 2;
            p_pic->p[V_PLANE].i_pixel_pitch = 1;
            p_pic->p[V_PLANE].i_visible_pitch = i_width / 2;

            /* We allocated 3 planes */
            p_pic->i_planes = 3;

#define P p_pic->p_sys->pixmap_i420
            P.componentInfoY.offset = (void *)p_pic->Y_PIXELS
                                       - p_pic->p_sys->p_info;
            P.componentInfoCb.offset = (void *)p_pic->U_PIXELS
                                        - p_pic->p_sys->p_info;
            P.componentInfoCr.offset = (void *)p_pic->V_PIXELS
                                        - p_pic->p_sys->p_info;

            P.componentInfoY.rowBytes = i_width;
            P.componentInfoCb.rowBytes = i_width / 2;
            P.componentInfoCr.rowBytes = i_width / 2;
#undef P

            break;

    default:
        /* Unknown chroma, tell the guy to get lost */
        free( p_pic->p_sys );
        msg_Err( p_vout, "never heard of chroma 0x%.8x (%4.4s)",
                 p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma );
        p_pic->i_planes = 0;
        return( -1 );
    }

    return( 0 );
}

/*****************************************************************************
 * QTFreePicture: destroy a picture allocated with QTNewPicture
 *****************************************************************************/
static void QTFreePicture( vout_thread_t *p_vout, picture_t *p_pic )
{
    switch( p_vout->output.i_chroma )
    {
        case VLC_FOURCC('I','4','2','0'):
            free( p_pic->p_data_orig );
            break;
    }

    free( p_pic->p_sys );
}

/*****************************************************************************
 * VLCWindow implementation
 *****************************************************************************/
@implementation VLCWindow

- (void)setVout:(vout_thread_t *)_p_vout
{
    p_vout = _p_vout;
}

780
781
782
783
784
- (vout_thread_t *)getVout
{
    return( p_vout );
}

hartman's avatar
hartman committed
785
- (void)scaleWindowWithFactor: (float)factor
786
787
{
    NSSize newsize;
788
    int i_corrected_height, i_corrected_width;
hartman's avatar
hartman committed
789
790
    NSPoint topleftbase;
    NSPoint topleftscreen;
791
    
hartman's avatar
hartman committed
792
793
794
795
796
797
    if ( !p_vout->b_fullscreen )
    {
        topleftbase.x = 0;
        topleftbase.y = [self frame].size.height;
        topleftscreen = [self convertBaseToScreen: topleftbase];
        
hartman's avatar
hartman committed
798
        if( p_vout->output.i_height * p_vout->output.i_aspect > 
799
800
801
802
803
804
805
806
807
808
                        p_vout->output.i_width * VOUT_ASPECT_FACTOR )
        {
            i_corrected_width = p_vout->output.i_height * p_vout->output.i_aspect /
                                            VOUT_ASPECT_FACTOR;
            newsize.width = (int) ( i_corrected_width * factor );
            newsize.height = (int) ( p_vout->render.i_height * factor );
        }
        else
        {
            i_corrected_height = p_vout->output.i_width * VOUT_ASPECT_FACTOR /
809
                                            p_vout->output.i_aspect;
810
811
812
813
            newsize.width = (int) ( p_vout->render.i_width * factor );
            newsize.height = (int) ( i_corrected_height * factor );
        }
    
hartman's avatar
hartman committed
814
815
816
817
818
        [self setContentSize: newsize];
        
        [self setFrameTopLeftPoint: topleftscreen];
        p_vout->i_changes |= VOUT_SIZE_CHANGE;
    }
819
820
}

hartman's avatar
hartman committed
821
822
823
824
825
826
827
828
829
830
831
832
833
834
- (void)toggleFloatOnTop
{
    if( config_GetInt( p_vout, "macosx-float" ) )
    {
        config_PutInt( p_vout, "macosx-float", 0 );
        [p_vout->p_sys->o_window setLevel: NSNormalWindowLevel];
    }
    else
    {
        config_PutInt( p_vout, "macosx-float", 1 );
        [p_vout->p_sys->o_window setLevel: NSStatusWindowLevel];
    }
}

835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
- (void)toggleFullscreen
{
    p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
}

- (BOOL)isFullscreen
{
    return( p_vout->b_fullscreen );
}

- (BOOL)canBecomeKeyWindow
{
    return( YES );
}

- (void)keyDown:(NSEvent *)o_event
{
    unichar key = 0;

    if( [[o_event characters] length] )
    {
        key = [[o_event characters] characterAtIndex: 0];
    }

    switch( key )
    {
        case 'f': case 'F':
            [self toggleFullscreen];
            break;

        case (unichar)0x1b: /* escape */
            if( [self isFullscreen] )
            {
                [self toggleFullscreen];
            }
            break;

        case 'q': case 'Q':
            p_vout->p_vlc->b_die = VLC_TRUE;
            break;

876
877
878
879
        case ' ':
            input_SetStatus( p_vout, INPUT_STATUS_PAUSE );
            break;

880
881
882
883
884
885
        default:
            [super keyDown: o_event];
            break;
    }
}

886
887
- (void)updateTitle
{
888
    NSMutableString * o_title;
hartman's avatar
hartman committed
889
    playlist_t * p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
890
                                                       FIND_ANYWHERE );
891
892
893
894
895
896
897
898
899
900
901
902
903
    
    if( p_playlist == NULL )
    {
        return;
    }

    vlc_mutex_lock( &p_playlist->object_lock );
    o_title = [NSMutableString stringWithUTF8String: 
        p_playlist->pp_items[p_playlist->i_index]->psz_name]; 
    vlc_mutex_unlock( &p_playlist->object_lock );

    vlc_object_release( p_playlist );

904
    if( o_title != nil )
905
    {
906
907
908
909
910
        NSRange prefix_range = [o_title rangeOfString: @"file:"];
        if( prefix_range.location != NSNotFound )
        {
            [o_title deleteCharactersInRange: prefix_range];
        }
911
912
913
914
915
916
917
918
919
920

        [self setTitleWithRepresentedFilename: o_title];
    }
    else
    {
        [self setTitle:
            [NSString stringWithCString: VOUT_TITLE " (QuickTime)"]];
    }
}

921
922
923
/* This is actually the same as VLCControls::stop. */
- (BOOL)windowShouldClose:(id)sender
{
hartman's avatar
hartman committed
924
    playlist_t * p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
925
926
927
928
929
930
931
932
933
934
935
936
937
                                                       FIND_ANYWHERE );
    if( p_playlist == NULL )      
    {
        return NO;
    }

    playlist_Stop( p_playlist );
    vlc_object_release( p_playlist );

    /* The window will be closed by the intf later. */
    return NO;
}

938
939
940
941
942
943
944
945
946
@end

/*****************************************************************************
 * VLCView implementation
 *****************************************************************************/
@implementation VLCView

- (void)drawRect:(NSRect)rect
{
947
948
949
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
950
    
951
952
    [[NSColor blackColor] set];
    NSRectFill( rect );
953
954
955
956
957
    [super drawRect: rect];

    p_vout->i_changes |= VOUT_SIZE_CHANGE;
}

958
959
960
961
962
963
964
- (BOOL)acceptsFirstResponder
{
    return( YES );
}

- (BOOL)becomeFirstResponder
{
hartman's avatar
hartman committed
965
966
967
968
969
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
    
    [o_window setAcceptsMouseMovedEvents: YES];
970
971
972
973
974
    return( YES );
}

- (BOOL)resignFirstResponder
{
hartman's avatar
hartman committed
975
976
977
978
979
980
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
    
    [o_window setAcceptsMouseMovedEvents: NO];
    VLCHideMouse( p_vout, NO );
981
982
983
    return( YES );
}

984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
- (void)mouseDown:(NSEvent *)o_event
{
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
    vlc_value_t val;

    switch( [o_event type] )
    {        
        case NSLeftMouseDown:
        {
            var_Get( p_vout, "mouse-button-down", &val );
            val.i_int |= 1;
            var_Set( p_vout, "mouse-button-down", val );
        }
        break;
        
        default:
            [super mouseDown: o_event];
        break;
    }
}

- (void)otherMouseDown:(NSEvent *)o_event
{
hartman's avatar
hartman committed
1009
1010
    /* This is not the the wheel button. you need to poll the
     * mouseWheel event for that. other is a third, forth or fifth button */
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
    vlc_value_t val;

    switch( [o_event type] )
    {
        case NSOtherMouseDown:
        {
            var_Get( p_vout, "mouse-button-down", &val );
            val.i_int |= 2;
            var_Set( p_vout, "mouse-button-down", val );
        }
        break;
        
        default:
            [super mouseDown: o_event];
        break;
    }
}

- (void)rightMouseDown:(NSEvent *)o_event
{
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
    vlc_value_t val;

    switch( [o_event type] )
    {
        case NSRightMouseDown:
        {
            var_Get( p_vout, "mouse-button-down", &val );
            val.i_int |= 4;
            var_Set( p_vout, "mouse-button-down", val );
        }
        break;
        
        default:
            [super mouseDown: o_event];
        break;
    }
}

1055
1056
- (void)mouseUp:(NSEvent *)o_event
{
1057
1058
1059
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
1060
    vlc_value_t val;
1061

1062
1063
1064
1065
    switch( [o_event type] )
    {
        case NSLeftMouseUp:
        {
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
            vlc_value_t b_val;
            b_val.b_bool = VLC_TRUE;
            var_Set( p_vout, "mouse-clicked", b_val );
            
            var_Get( p_vout, "mouse-button-down", &val );
            val.i_int &= ~1;
            var_Set( p_vout, "mouse-button-down", val );
        }
        break;
                
        default:
            [super mouseUp: o_event];
        break;
    }
}

- (void)otherMouseUp:(NSEvent *)o_event
{
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
    vlc_value_t val;

    switch( [o_event type] )
    {
        case NSOtherMouseUp:
        {
            var_Get( p_vout, "mouse-button-down", &val );
            val.i_int &= ~2;
            var_Set( p_vout, "mouse-button-down", val );
1096
1097
        }
        break;
1098
1099
1100
1101
1102
1103
                
        default:
            [super mouseUp: o_event];
        break;
    }
}
1104

1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
- (void)rightMouseUp:(NSEvent *)o_event
{
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];
    vlc_value_t val;

    switch( [o_event type] )
    {
        case NSRightMouseUp:
        {
            var_Get( p_vout, "mouse-button-down", &val );
            val.i_int &= ~4;
            var_Set( p_vout, "mouse-button-down", val );
        }
        break;
        
1122
1123
1124
1125
1126
1127
        default:
            [super mouseUp: o_event];
        break;
    }
}

1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
- (void)mouseDragged:(NSEvent *)o_event
{
    [self mouseMoved:o_event];
}

- (void)otherMouseDragged:(NSEvent *)o_event
{
    [self mouseMoved:o_event];
}

- (void)rightMouseDragged:(NSEvent *)o_event
{
    [self mouseMoved:o_event];
}

1143
1144
1145
1146
1147
1148
- (void)mouseMoved:(NSEvent *)o_event
{
    NSPoint ml;
    NSRect s_rect;
    BOOL b_inside;

1149
1150
1151
1152
    vout_thread_t * p_vout;
    id o_window = [self window];
    p_vout = (vout_thread_t *)[o_window getVout];

1153
1154
1155
1156
1157
1158
1159
1160
    s_rect = [self bounds];
    ml = [self convertPoint: [o_event locationInWindow] fromView: nil];
    b_inside = [self mouse: ml inRect: s_rect];

    if( b_inside )
    {
        vlc_value_t val;
        int i_width, i_height, i_x, i_y;
1161
        
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
        vout_PlacePicture( p_vout, (unsigned int)s_rect.size.width,
                                   (unsigned int)s_rect.size.height,
                                   &i_x, &i_y, &i_width, &i_height );

        val.i_int = ( ((int)ml.x) - i_x ) * 
                    p_vout->render.i_width / i_width;
        var_Set( p_vout, "mouse-x", val );

        val.i_int = ( ((int)ml.y) - i_y ) * 
                    p_vout->render.i_height / i_height;
        var_Set( p_vout, "mouse-y", val );
1173
            
1174
1175
        val.b_bool = VLC_TRUE;
        var_Set( p_vout, "mouse-moved", val );
hartman's avatar
hartman committed
1176
1177
        p_vout->p_sys->i_time_mouse_last_moved = mdate();
        p_vout->p_sys->b_mouse_moved = YES;
1178
    }
hartman's avatar
hartman committed
1179
1180
1181
1182
1183
1184
1185
    else if ( !b_inside && !p_vout->p_sys->b_mouse_pointer_visible )
    {
        /* people with multiple monitors need their mouse,
         * even if VLCView in fullscreen. */
        VLCHideMouse( p_vout, NO );
    }
    
hartman's avatar
hartman committed
1186
    [super mouseMoved: o_event];
1187
1188
}

1189
@end
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201

/*****************************************************************************
 * VLCVout implementation
 *****************************************************************************/
@implementation VLCVout

- (void)createWindow:(NSValue *)o_value
{
    vlc_value_t val;
    VLCView * o_view;
    NSScreen * o_screen;
    vout_thread_t * p_vout;
1202
    vlc_bool_t b_main_screen;
hartman's avatar
hartman committed
1203
    
1204
1205
1206
1207
1208
1209
1210
1211
1212
    p_vout = (vout_thread_t *)[o_value pointerValue];

    p_vout->p_sys->o_window = [VLCWindow alloc];
    [p_vout->p_sys->o_window setVout: p_vout];
    [p_vout->p_sys->o_window setReleasedWhenClosed: YES];

    if( var_Get( p_vout, "video-device", &val ) < 0 )
    {
        o_screen = [NSScreen mainScreen];
1213
        b_main_screen = 1;
1214
1215
1216
    }
    else
    {
1217
        unsigned int i_index = 0;
1218
1219
        NSArray *o_screens = [NSScreen screens];

1220
        if( !sscanf( val.psz_string, _("Screen %d"), &i_index ) ||
1221
1222
1223
            [o_screens count] < i_index )
        {
            o_screen = [NSScreen mainScreen];
1224
            b_main_screen = 1;
1225
1226
1227
        }
        else
        {
1228
1229
1230
            i_index--;
            o_screen = [o_screens objectAtIndex: i_index];
            config_PutInt( p_vout, "macosx-vdev", i_index );
1231
            b_main_screen = (i_index == 0);
1232
1233
1234
1235
1236
1237
1238
        } 

        free( val.psz_string );
    } 

    if( p_vout->b_fullscreen )
    {
1239
1240
1241
        NSRect screen_rect = [o_screen frame];
        screen_rect.origin.x = screen_rect.origin.y = 0;

1242
1243
        if ( b_main_screen && p_vout->p_sys->p_fullscreen_state == NULL )
            BeginFullScreen( &p_vout->p_sys->p_fullscreen_state, NULL, 0, 0,
1244
                             NULL, NULL, fullScreenAllowEvents );
1245

1246
        [p_vout->p_sys->o_window 
1247
            initWithContentRect: screen_rect
1248
1249
1250
1251
            styleMask: NSBorderlessWindowMask
            backing: NSBackingStoreBuffered
            defer: NO screen: o_screen];

1252
        [p_vout->p_sys->o_window setLevel: NSPopUpMenuWindowLevel - 1];
hartman's avatar
hartman committed
1253
        p_vout->p_sys->b_mouse_moved = YES;
1254
        p_vout->p_sys->i_time_mouse_last_moved = mdate();
1255
1256
1257
1258
1259
    }
    else
    {
        unsigned int i_stylemask = NSTitledWindowMask |
                                   NSMiniaturizableWindowMask |
1260
                                   NSClosableWindowMask |
1261
                                   NSResizableWindowMask;
1262
        
1263
1264
1265
1266
        if ( p_vout->p_sys->p_fullscreen_state != NULL )
            EndFullScreen ( p_vout->p_sys->p_fullscreen_state, NULL );
        p_vout->p_sys->p_fullscreen_state = NULL;

1267
1268
1269
1270
1271
1272
        [p_vout->p_sys->o_window 
            initWithContentRect: p_vout->p_sys->s_rect
            styleMask: i_stylemask
            backing: NSBackingStoreBuffered
            defer: NO screen: o_screen];

hartman's avatar
hartman committed
1273
1274
1275
1276
1277
1278
1279
        [p_vout->p_sys->o_window setAlphaValue: config_GetFloat( p_vout, "macosx-opaqueness" )];
        
        if( config_GetInt( p_vout, "macosx-float" ) )
        {
            [p_vout->p_sys->o_window setLevel: NSStatusWindowLevel];
        }
        
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
        if( !p_vout->p_sys->b_pos_saved )   
        {
            [p_vout->p_sys->o_window center];
        }
    }

    o_view = [[VLCView alloc] init];
    /* FIXME: [o_view setMenu:] */
    [p_vout->p_sys->o_window setContentView: o_view];
    [o_view autorelease];

    [o_view lockFocus];
    p_vout->p_sys->p_qdport = [o_view qdPort];
    [o_view unlockFocus];
1294
1295
1296
    
    [p_vout->p_sys->o_window updateTitle];
    [p_vout->p_sys->o_window makeKeyAndOrderFront: nil];
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
}

- (void)destroyWindow:(NSValue *)o_value
{
    vout_thread_t * p_vout;

    p_vout = (vout_thread_t *)[o_value pointerValue];

    if( !p_vout->b_fullscreen )
    {
        NSRect s_rect;

        s_rect = [[p_vout->p_sys->o_window contentView] frame];
        p_vout->p_sys->s_rect.size = s_rect.size;

        s_rect = [p_vout->p_sys->o_window frame];
        p_vout->p_sys->s_rect.origin = s_rect.origin;

hartman's avatar
hartman committed
1315
        p_vout->p_sys->b_pos_saved = YES;
1316
    }
1317
    
1318
1319
1320
1321
1322
1323
    p_vout->p_sys->p_qdport = nil;
    [p_vout->p_sys->o_window close];
    p_vout->p_sys->o_window = nil;
}

@end