Digital Video (Firewire/IEEE1394/I-Link) input for Camcorders
[vlc.git] / modules / access / dv.c
1 /*****************************************************************************
2  * dv.c: Digital video/Firewire input (file: access plug-in)
3  *****************************************************************************
4  * Copyright (C) 2005 M2X
5  * $Id: dv.c 12318 2005-08-21 17:46:48Z jpsaman $
6  *
7  * Authors: Jean-Paul Saman <jpsaman at m2x dot nl>
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <vlc/vlc.h>
28 #include <vlc/input.h>
29
30 #include <stdlib.h>
31 #include <string.h>
32 #include <errno.h>
33 #ifdef HAVE_SYS_TYPES_H
34 #   include <sys/types.h>
35 #endif
36 #ifdef HAVE_SYS_TIME_H
37 #   include <sys/time.h>
38 #endif
39 #ifdef HAVE_SYS_STAT_H
40 #   include <sys/stat.h>
41 #endif
42 #ifdef HAVE_FCNTL_H
43 #   include <fcntl.h>
44 #endif
45
46 #ifdef HAVE_UNISTD_H
47 #   include <unistd.h>
48 #elif defined( WIN32 ) && !defined( UNDER_CE )
49 #   include <io.h>
50 #endif
51
52 #include <sys/poll.h>
53
54 #include <libraw1394/raw1394.h>
55 #include <libraw1394/csr.h>
56 #include <libavc1394/avc1394.h>
57 #include <libavc1394/avc1394_vcr.h>
58 #include <libavc1394/rom1394.h>
59
60 /*****************************************************************************
61  * Module descriptor
62  *****************************************************************************/
63 static int  Open ( vlc_object_t * );
64 static void Close( vlc_object_t * );
65 static block_t *Block( access_t * );
66 static int Control( access_t *, int, va_list );
67
68 #define CACHING_TEXT N_("Caching value in ms")
69 #define CACHING_LONGTEXT N_( \
70     "Allows you to modify the default caching value for file streams. This " \
71     "value should be set in millisecond units." )
72
73 vlc_module_begin();
74     set_description( _("Digital Video (Firewire/ieee1394)  input") );
75     set_shortname( _("dv") );
76     set_category( CAT_INPUT );
77     set_subcategory( SUBCAT_INPUT_ACCESS );
78     add_integer( "dv-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
79     set_capability( "access2", 50 );
80     add_shortcut( "dv" );
81     add_shortcut( "dv1394" );
82     add_shortcut( "raw1394" );
83     set_callbacks( Open, Close );
84 vlc_module_end();
85
86 typedef struct
87 {
88     VLC_COMMON_MEMBERS
89
90     access_t        *p_access;
91     vlc_mutex_t     lock;
92     block_t         *p_frame;
93     block_t         **pp_last;
94
95 } event_thread_t;
96
97 static int Raw1394EventThread( vlc_object_t * );
98 static int Raw1394Handler( raw1394handle_t, int, size_t, quadlet_t * );
99
100 static int Raw1394GetNumPorts( access_t *p_access );
101 static raw1394handle_t Raw1394Open( access_t *, int );
102 static void Raw1394Close( raw1394handle_t );
103
104 static int DiscoverAVC( access_t *, int *, uint64_t );
105 static raw1394handle_t AVCOpen( access_t *, int );
106 static void AVCClose( access_t * );
107 static int AVCResetHandler( raw1394handle_t, unsigned int );
108 static int AVCPlay( access_t *, int );
109 static int AVCPause( access_t *, int );
110 static int AVCStop( access_t *, int );
111
112 struct access_sys_t
113 {
114     raw1394handle_t p_avc1394;
115     raw1394handle_t p_raw1394;
116     struct pollfd   raw1394_poll;
117
118     int i_cards;
119     int i_node;
120     int i_port;
121     int i_channel;
122     uint64_t i_guid;
123
124     /* event */
125     event_thread_t *p_ev;
126     vlc_mutex_t lock;
127     block_t *p_frame;
128 };
129
130 /*****************************************************************************
131  * Open: open the file
132  *****************************************************************************/
133 static int Open( vlc_object_t *p_this )
134 {
135     access_t     *p_access = (access_t*)p_this;
136     access_sys_t *p_sys;
137     char *psz_name = strdup( p_access->psz_path );
138
139     struct raw1394_portinfo port_inf[ 16 ];
140     iso_handler_t oldhandler;
141
142     msg_Dbg( p_access, "opening device %s", psz_name );
143
144     /* Set up p_access */
145     p_access->pf_read = NULL;
146     p_access->pf_block = Block;
147     p_access->pf_control = Control;
148     p_access->pf_seek = NULL;
149     p_access->info.i_update = 0;
150     p_access->info.i_size = 0;
151     p_access->info.i_pos = 0;
152     p_access->info.b_eof = VLC_FALSE;
153     p_access->info.b_prebuffered = VLC_FALSE;
154     p_access->info.i_title = 0;
155     p_access->info.i_seekpoint = 0;
156
157     p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
158     if( !p_sys )
159     {
160         free( psz_name );
161         return VLC_EGENERIC;
162     }
163
164     p_sys->i_cards = 0;
165     p_sys->i_node = 0;
166     p_sys->i_port = 0;
167     p_sys->i_guid = 0;
168     p_sys->i_channel = 63;
169     p_sys->p_raw1394 = NULL;
170     p_sys->p_avc1394 = NULL;
171     p_sys->p_frame = NULL;
172
173     vlc_mutex_init( p_access, &p_sys->lock );
174
175     p_sys->i_node = DiscoverAVC( p_access, &p_sys->i_port, p_sys->i_guid );
176     p_sys->p_avc1394 = AVCOpen( p_access, p_sys->i_port );
177     if( !p_sys->p_avc1394 )
178     {
179         msg_Err( p_access, "no Digital Video Control device found on %s", psz_name );
180         Close( p_this );
181         free( psz_name );
182         return VLC_EGENERIC;
183     }
184
185     p_sys->p_raw1394 = raw1394_new_handle();
186     if( !p_sys->p_raw1394 )
187     {
188         msg_Err( p_access, "no Digital Video device found on %s", psz_name );
189         Close( p_this );
190         free( psz_name );
191         return VLC_EGENERIC;
192     }
193
194     p_sys->i_cards = raw1394_get_port_info( p_sys->p_raw1394, port_inf, 16 );
195     if( p_sys->i_cards < 0 )
196     {
197         msg_Err( p_access, "failed to get port info for %s", psz_name );
198         Close( p_this );
199         free( psz_name );
200         return VLC_EGENERIC;
201     }
202
203     if( raw1394_set_port( p_sys->p_raw1394, p_sys->i_port ) < 0 )
204     {
205         msg_Err( p_access, "failed to set port info for %s", psz_name );
206         Close( p_this );
207         free( psz_name );
208         return VLC_EGENERIC;
209     }
210
211     oldhandler = raw1394_set_iso_handler( p_sys->p_raw1394,
212                                           p_sys->i_channel, Raw1394Handler );
213     raw1394_set_userdata( p_sys->p_raw1394, p_access );
214     raw1394_start_iso_rcv( p_sys->p_raw1394, p_sys->i_channel );
215
216     p_sys->raw1394_poll.fd = raw1394_get_fd( p_sys->p_raw1394 );
217     p_sys->raw1394_poll.events = POLLIN | POLLERR | POLLHUP | POLLPRI;
218
219     /* Update default_pts to a suitable value for udp access */
220     var_Create( p_access, "dv-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
221
222     /* Now create our event thread catcher */
223     p_sys->p_ev = vlc_object_create( p_access, sizeof( event_thread_t ) );
224     p_sys->p_ev->p_frame = NULL;
225     p_sys->p_ev->pp_last = &p_sys->p_ev->p_frame;
226     p_sys->p_ev->p_access = p_access;
227     vlc_mutex_init( p_access, &p_sys->p_ev->lock );
228     vlc_thread_create( p_sys->p_ev, "dv event thread handler", Raw1394EventThread,
229                        VLC_THREAD_PRIORITY_INPUT, VLC_FALSE );
230
231     free( psz_name );
232     return VLC_SUCCESS;
233 }
234
235 /*****************************************************************************
236  * Close: free unused data structures
237  *****************************************************************************/
238 static void Close( vlc_object_t *p_this )
239 {
240     access_t     *p_access = (access_t*)p_this;
241     access_sys_t *p_sys = p_access->p_sys;
242
243     /* stop the event handler */
244     p_sys->p_ev->b_die = VLC_TRUE;
245
246     if( p_sys->p_raw1394)
247         raw1394_stop_iso_rcv( p_sys->p_raw1394, p_sys->i_channel );
248
249     vlc_mutex_destroy( &p_sys->p_ev->lock );
250     vlc_thread_join( p_sys->p_ev );
251
252     /* Cleanup frame data */
253     if( p_sys->p_ev->p_frame )
254     {
255         vlc_mutex_lock( &p_sys->p_ev->lock );
256         block_ChainRelease( p_sys->p_ev->p_frame );
257         p_sys->p_ev->p_frame = NULL;
258         p_sys->p_ev->pp_last = &p_sys->p_frame;
259         vlc_mutex_unlock( &p_sys->p_ev->lock );
260     }
261     vlc_object_destroy( p_sys->p_ev );
262
263     if( p_sys->p_frame )
264         block_ChainRelease( p_sys->p_frame );
265     if( p_sys->p_raw1394)
266         raw1394_destroy_handle( p_sys->p_raw1394 );
267
268     AVCClose( p_access );
269
270     vlc_mutex_destroy( &p_sys->lock );
271     free( p_sys );
272 }
273
274 /*****************************************************************************
275  * Control:
276  *****************************************************************************/
277 static int Control( access_t *p_access, int i_query, va_list args )
278 {
279     access_sys_t *p_sys = p_access->p_sys;
280     vlc_bool_t   *pb_bool;
281    // int          *pi_int;
282     int64_t      *pi_64;
283
284     switch( i_query )
285     {
286         /* */
287         case ACCESS_CAN_SEEK:
288         case ACCESS_CAN_FASTSEEK:
289         case ACCESS_CAN_PAUSE:
290         case ACCESS_CAN_CONTROL_PACE:
291             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
292             *pb_bool = VLC_FALSE;
293             break;
294
295         case ACCESS_GET_PTS_DELAY:
296             pi_64 = (int64_t*)va_arg( args, int64_t * );
297             *pi_64 = var_GetInteger( p_access, "dv-caching" ) * 1000;
298             break;
299
300         /* */
301         case ACCESS_SET_PAUSE_STATE:
302             AVCPause( p_access, p_sys->i_node );
303             break;
304
305         case ACCESS_GET_TITLE_INFO:
306         case ACCESS_SET_TITLE:
307         case ACCESS_SET_SEEKPOINT:
308         case ACCESS_SET_PRIVATE_ID_STATE:
309             return VLC_EGENERIC;
310
311         default:
312             msg_Warn( p_access, "unimplemented query in control" );
313             return VLC_EGENERIC;
314
315     }
316     return VLC_SUCCESS;
317 }
318
319 static block_t *Block( access_t *p_access )
320 {
321     access_sys_t *p_sys = p_access->p_sys;
322     block_t *p_block = NULL;
323
324 //     if( !p_access->psz_demux )
325 //         p_access->psz_demux = strdup( "rawdv" );
326
327     vlc_mutex_lock( &p_sys->lock );
328     p_block = p_sys->p_frame;
329     //msg_Dbg( p_access, "sending frame %p",p_block );
330     p_sys->p_frame = NULL;
331     vlc_mutex_unlock( &p_sys->lock );
332
333     return p_block;
334 }
335
336 static int Raw1394EventThread( vlc_object_t *p_this )
337 {
338     event_thread_t *p_ev = (event_thread_t *) p_this;
339     access_t *p_access = (access_t *) p_ev->p_access;
340     access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
341     int result = 0;
342
343     AVCPlay( p_access, p_sys->i_node );
344
345     vlc_thread_ready( p_this );
346
347     while( !p_sys->p_ev->b_die )
348     {
349         while( ( result = poll( &(p_sys->raw1394_poll), 1, 200 ) ) < 0 )
350         {
351             if( !( errno == EAGAIN || errno == EINTR ) )
352             {
353                 perror( "error: raw1394 poll" );
354                 msg_Err( p_access, "retrying device raw1394" );
355             }
356             if( p_sys->p_ev->b_die )
357                 break;
358         }
359         if( p_sys->p_ev->b_die )
360                 break;
361         if( result > 0 && ( ( p_sys->raw1394_poll.revents & POLLIN )
362                 || ( p_sys->raw1394_poll.revents & POLLPRI ) ) )
363             result = raw1394_loop_iterate( p_sys->p_raw1394 );
364     }
365
366     AVCStop( p_access, p_sys->i_node );
367     return VLC_SUCCESS;
368 }
369
370 static int Raw1394Handler( raw1394handle_t handle, int channel, size_t length, quadlet_t *data )
371 {
372     access_t *p_access = NULL;
373     access_sys_t *p_sys = NULL;
374     block_t *p_block = NULL;
375
376     p_access = (access_t *) raw1394_get_userdata( handle );
377     if( !p_access ) return 0;
378
379     p_sys = p_access->p_sys;
380
381     /* skip empty packets */
382     if ( length > 16 )
383     {
384         unsigned char * p = ( unsigned char* ) &data[ 3 ];
385         int section_type = p[ 0 ] >> 5;           /* section type is in bits 5 - 7 */
386         int dif_sequence = p[ 1 ] >> 4;           /* dif sequence number is in bits 4 - 7 */
387         int dif_block = p[ 2 ];
388
389         vlc_mutex_lock( &p_sys->p_ev->lock );
390
391         /* if we are at the beginning of a frame, we put the previous
392            frame in our output_queue. */
393         if( (section_type == 0) && (dif_sequence == 0) )
394         {
395             vlc_mutex_lock( &p_sys->lock );
396             if( p_sys->p_ev->p_frame )
397             {
398                 /* Push current frame to p_access thread. */
399                 //p_sys->p_ev->p_frame->i_pts = mdate();
400                 block_ChainAppend( &p_sys->p_frame, p_sys->p_ev->p_frame );
401             }
402             /* reset list */
403             p_sys->p_ev->p_frame = block_New( p_access, 144000 );
404             p_sys->p_ev->pp_last = &p_sys->p_frame;
405             vlc_mutex_unlock( &p_sys->lock );
406         }
407
408         p_block = p_sys->p_ev->p_frame;
409         if( p_block )
410         {
411             switch ( section_type )
412             {
413             case 0:    /* 1 Header block */
414                 /* p[3] |= 0x80; // hack to force PAL data */
415                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80, p, 480 );
416                 break;
417
418             case 1:    /* 2 Subcode blocks */
419                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 1 + dif_block ) * 80, p, 480 );
420                 break;
421
422             case 2:    /* 3 VAUX blocks */
423                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 3 + dif_block ) * 80, p, 480 );
424                 break;
425
426             case 3:    /* 9 Audio blocks interleaved with video */
427                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 6 + dif_block * 16 ) * 80, p, 480 );
428                 break;
429
430             case 4:    /* 135 Video blocks interleaved with audio */
431                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 7 + ( dif_block / 15 ) + dif_block ) * 80, p, 480 );
432                 break;
433
434             default:    /* we canĀ“t handle any other data */
435                 block_Release( p_block );
436                 p_block = NULL;
437                 break;
438             }
439         }
440         vlc_mutex_unlock( &p_sys->p_ev->lock );
441     }
442     return 0;
443 }
444
445 /*
446  * Routing borrowed from dvgrab-1.8
447  * Copyright by Arne Schirmacher <dvgrab@schirmacher.de>
448  * Dan Dennedy <dan@dennedy.org> and others
449  */
450 static int Raw1394GetNumPorts( access_t *p_access )
451 {
452     int n_ports;
453     struct raw1394_portinfo pinf[ 16 ];
454     raw1394handle_t handle;
455
456     /* get a raw1394 handle */
457     if ( !( handle = raw1394_new_handle() ) )
458     {
459         msg_Err( p_access, "raw1394 - failed to get handle: %s.\n", strerror( errno ) );
460         return VLC_EGENERIC;
461     }
462
463     if ( ( n_ports = raw1394_get_port_info( handle, pinf, 16 ) ) < 0 )
464     {
465         msg_Err( p_access, "raw1394 - failed to get port info: %s.\n", strerror( errno ) );
466         raw1394_destroy_handle( handle );
467         return VLC_EGENERIC;
468     }
469     raw1394_destroy_handle( handle );
470
471     return n_ports;
472 }
473
474 static raw1394handle_t Raw1394Open( access_t *p_access, int port )
475 {
476     int n_ports;
477     struct raw1394_portinfo pinf[ 16 ];
478     raw1394handle_t handle;
479
480     /* get a raw1394 handle */
481 #ifdef RAW1394_V_0_8
482
483     handle = raw1394_get_handle();
484 #else
485
486     handle = raw1394_new_handle();
487 #endif
488
489     if ( !handle )
490     {
491         msg_Err( p_access, "raw1394 - failed to get handle: %s.\n", strerror( errno ) );
492         return NULL;
493     }
494
495     if ( ( n_ports = raw1394_get_port_info( handle, pinf, 16 ) ) < 0 )
496     {
497         msg_Err( p_access, "raw1394 - failed to get port info: %s.\n", strerror( errno ) );
498         raw1394_destroy_handle( handle );
499         return NULL;
500     }
501
502     /* tell raw1394 which host adapter to use */
503     if ( raw1394_set_port( handle, port ) < 0 )
504     {
505         msg_Err( p_access, "raw1394 - failed to set set port: %s.\n", strerror( errno ) );
506         return NULL;
507     }
508
509     return handle;
510 }
511
512 static void Raw1394Close( raw1394handle_t handle )
513 {
514     raw1394_destroy_handle( handle );
515 }
516
517 static int DiscoverAVC( access_t *p_access, int* port, uint64_t guid )
518 {
519     rom1394_directory rom_dir;
520     raw1394handle_t handle;
521     int device = -1;
522     int i, j = 0;
523     int m = Raw1394GetNumPorts( p_access );
524
525     if( *port >= 0 )
526     {
527         /* search on explicit port */
528         j = *port;
529         m = *port + 1;
530     }
531
532     for( ; j < m && device == -1; j++ )
533     {
534         handle = Raw1394Open( p_access, j );
535         for( i = 0; i < raw1394_get_nodecount( handle ); ++i )
536         {
537             if( guid != 0 )
538             {
539                 /* select explicitly by GUID */
540                 if( guid == rom1394_get_guid( handle, i ) )
541                 {
542                     device = i;
543                     *port = j;
544                     break;
545                 }
546             }
547             else
548             {
549                 /* select first AV/C Tape Reccorder Player node */
550                 if( rom1394_get_directory( handle, i, &rom_dir ) < 0 )
551                 {
552                     msg_Err( p_access, "error reading config rom directory for node %d\n", i );
553                     continue;
554                 }
555                 if( ( rom1394_get_node_type( &rom_dir ) == ROM1394_NODE_TYPE_AVC ) &&
556                         avc1394_check_subunit_type( handle, i, AVC1394_SUBUNIT_TYPE_VCR ) )
557                 {
558                     device = i;
559                     *port = j;
560                     break;
561                 }
562             }
563         }
564         Raw1394Close( handle );
565     }
566
567     return device;
568 }
569
570 /*
571  * Handle AVC commands
572  */
573 static raw1394handle_t AVCOpen( access_t *p_access, int port )
574 {
575     access_sys_t *p_sys = p_access->p_sys;
576     int numcards;
577     struct raw1394_portinfo pinf[ 16 ];
578
579     p_sys->p_avc1394 = raw1394_new_handle();
580     if( !p_sys->p_avc1394 )
581         return NULL;
582
583     numcards = raw1394_get_port_info( p_sys->p_avc1394, pinf, 16 );
584     if( numcards < -1 )
585         return NULL;
586     if( raw1394_set_port( p_sys->p_avc1394, port ) < 0 )
587         return NULL;
588
589     raw1394_set_bus_reset_handler( p_sys->p_avc1394, AVCResetHandler );
590
591     return  p_sys->p_avc1394;
592 }
593
594 static void AVCClose( access_t *p_access )
595 {
596     access_sys_t *p_sys = p_access->p_sys;
597
598     if( p_sys->p_avc1394 )
599     {
600         raw1394_destroy_handle( p_sys->p_avc1394 );
601         p_sys->p_avc1394 = NULL;
602     }
603 }
604
605
606 static int AVCResetHandler( raw1394handle_t handle, unsigned int generation )
607 {
608     raw1394_update_generation( handle, generation );
609     return 0;
610 }
611
612 static int AVCPlay( access_t *p_access, int phyID )
613 {
614     access_sys_t *p_sys = p_access->p_sys;
615
616     msg_Dbg( p_access, "send play command over Digital Video control channel" );
617     if( !p_sys->p_avc1394 )
618         return 0;
619
620     if( phyID >= 0 )
621     {
622         if( !avc1394_vcr_is_recording( p_sys->p_avc1394, phyID ) &&
623             avc1394_vcr_is_playing( p_sys->p_avc1394, phyID ) != AVC1394_VCR_OPERAND_PLAY_FORWARD )
624                 avc1394_vcr_play( p_sys->p_avc1394, phyID );
625     }
626     return 0;
627 }
628
629 static int AVCPause( access_t *p_access, int phyID )
630 {
631     access_sys_t *p_sys = p_access->p_sys;
632
633     if( !p_sys->p_avc1394 )
634         return 0;
635
636     if( phyID >= 0 )
637     {
638         if( !avc1394_vcr_is_recording( p_sys->p_avc1394, phyID ) &&
639             ( avc1394_vcr_is_playing( p_sys->p_avc1394, phyID ) != AVC1394_VCR_OPERAND_PLAY_FORWARD_PAUSE ) )
640                 avc1394_vcr_pause( p_sys->p_avc1394, phyID );
641     }
642     return 0;
643 }
644
645
646 static int AVCStop( access_t *p_access, int phyID )
647 {
648     access_sys_t *p_sys = p_access->p_sys;
649
650     msg_Dbg( p_access, "closing Digital Video control channel" );
651     if( !p_sys->p_avc1394 )
652         return 0;
653
654     if ( phyID >= 0 )
655         avc1394_vcr_stop( p_sys->p_avc1394, phyID );
656
657     return 0;
658 }