Access strings (Refs:#438)
[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$
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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     "Default caching value for DV streams. This" \
71     "value should be set in milliseconds." )
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", 60000 / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
79     set_capability( "access2", 0 );
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     if( p_sys->i_node < 0 )
177     {
178         msg_Err( p_access, "failed to open a Firewire (IEEE1394) connection" );
179         Close( p_this );
180         free( psz_name );
181         return VLC_EGENERIC;
182     }
183
184     p_sys->p_avc1394 = AVCOpen( p_access, p_sys->i_port );
185     if( !p_sys->p_avc1394 )
186     {
187         msg_Err( p_access, "no Digital Video Control device found on %s", psz_name );
188         Close( p_this );
189         free( psz_name );
190         return VLC_EGENERIC;
191     }
192
193     p_sys->p_raw1394 = raw1394_new_handle();
194     if( !p_sys->p_raw1394 )
195     {
196         msg_Err( p_access, "no Digital Video device found on %s", psz_name );
197         Close( p_this );
198         free( psz_name );
199         return VLC_EGENERIC;
200     }
201
202     p_sys->i_cards = raw1394_get_port_info( p_sys->p_raw1394, port_inf, 16 );
203     if( p_sys->i_cards < 0 )
204     {
205         msg_Err( p_access, "failed to get port info for %s", psz_name );
206         Close( p_this );
207         free( psz_name );
208         return VLC_EGENERIC;
209     }
210
211     if( raw1394_set_port( p_sys->p_raw1394, p_sys->i_port ) < 0 )
212     {
213         msg_Err( p_access, "failed to set port info for %s", psz_name );
214         Close( p_this );
215         free( psz_name );
216         return VLC_EGENERIC;
217     }
218
219     oldhandler = raw1394_set_iso_handler( p_sys->p_raw1394,
220                                           p_sys->i_channel, Raw1394Handler );
221     raw1394_set_userdata( p_sys->p_raw1394, p_access );
222     raw1394_start_iso_rcv( p_sys->p_raw1394, p_sys->i_channel );
223
224     p_sys->raw1394_poll.fd = raw1394_get_fd( p_sys->p_raw1394 );
225     p_sys->raw1394_poll.events = POLLIN | POLLERR | POLLHUP | POLLPRI;
226
227     /* Update default_pts to a suitable value for udp access */
228     var_Create( p_access, "dv-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
229
230     /* Now create our event thread catcher */
231     p_sys->p_ev = vlc_object_create( p_access, sizeof( event_thread_t ) );
232     p_sys->p_ev->p_frame = NULL;
233     p_sys->p_ev->pp_last = &p_sys->p_ev->p_frame;
234     p_sys->p_ev->p_access = p_access;
235     vlc_mutex_init( p_access, &p_sys->p_ev->lock );
236     vlc_thread_create( p_sys->p_ev, "dv event thread handler", Raw1394EventThread,
237                        VLC_THREAD_PRIORITY_OUTPUT, VLC_FALSE );
238
239     free( psz_name );
240     return VLC_SUCCESS;
241 }
242
243 /*****************************************************************************
244  * Close: free unused data structures
245  *****************************************************************************/
246 static void Close( vlc_object_t *p_this )
247 {
248     access_t     *p_access = (access_t*)p_this;
249     access_sys_t *p_sys = p_access->p_sys;
250
251     if( p_sys->p_ev )
252     {
253         /* stop the event handler */
254         p_sys->p_ev->b_die = VLC_TRUE;
255
256         if( p_sys->p_raw1394 )
257             raw1394_stop_iso_rcv( p_sys->p_raw1394, p_sys->i_channel );
258
259         vlc_mutex_destroy( &p_sys->p_ev->lock );
260         vlc_thread_join( p_sys->p_ev );
261
262         /* Cleanup frame data */
263         if( p_sys->p_ev->p_frame )
264         {
265             vlc_mutex_lock( &p_sys->p_ev->lock );
266             block_ChainRelease( p_sys->p_ev->p_frame );
267             p_sys->p_ev->p_frame = NULL;
268             p_sys->p_ev->pp_last = &p_sys->p_frame;
269             vlc_mutex_unlock( &p_sys->p_ev->lock );
270         }
271         vlc_object_destroy( p_sys->p_ev );
272     }
273
274     if( p_sys->p_frame )
275         block_ChainRelease( p_sys->p_frame );
276     if( p_sys->p_raw1394 )
277         raw1394_destroy_handle( p_sys->p_raw1394 );
278
279     AVCClose( p_access );
280
281     vlc_mutex_destroy( &p_sys->lock );
282     free( p_sys );
283 }
284
285 /*****************************************************************************
286  * Control:
287  *****************************************************************************/
288 static int Control( access_t *p_access, int i_query, va_list args )
289 {
290     access_sys_t *p_sys = p_access->p_sys;
291     vlc_bool_t   *pb_bool;
292     int64_t      *pi_64;
293
294     switch( i_query )
295     {
296         /* */
297         case ACCESS_CAN_SEEK:
298         case ACCESS_CAN_FASTSEEK:
299         case ACCESS_CAN_PAUSE:
300             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
301             *pb_bool = VLC_TRUE;
302             break;
303
304         case ACCESS_CAN_CONTROL_PACE:
305             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
306             *pb_bool = VLC_FALSE;
307             break;
308
309         case ACCESS_GET_PTS_DELAY:
310             pi_64 = (int64_t*)va_arg( args, int64_t * );
311             *pi_64 = var_GetInteger( p_access, "dv-caching" ) * 1000;
312             break;
313
314         /* */
315         case ACCESS_SET_PAUSE_STATE:
316             AVCPause( p_access, p_sys->i_node );
317             break;
318
319         case ACCESS_GET_TITLE_INFO:
320         case ACCESS_SET_TITLE:
321         case ACCESS_SET_SEEKPOINT:
322         case ACCESS_SET_PRIVATE_ID_STATE:
323             return VLC_EGENERIC;
324
325         default:
326             msg_Warn( p_access, "unimplemented query in control" );
327             return VLC_EGENERIC;
328
329     }
330     return VLC_SUCCESS;
331 }
332
333 static block_t *Block( access_t *p_access )
334 {
335     access_sys_t *p_sys = p_access->p_sys;
336     block_t *p_block = NULL;
337
338 //     if( !p_access->psz_demux )
339 //         p_access->psz_demux = strdup( "rawdv" );
340
341     vlc_mutex_lock( &p_sys->lock );
342     p_block = p_sys->p_frame;
343     //msg_Dbg( p_access, "sending frame %p",p_block );
344     p_sys->p_frame = NULL;
345     vlc_mutex_unlock( &p_sys->lock );
346
347     return p_block;
348 }
349
350 static int Raw1394EventThread( vlc_object_t *p_this )
351 {
352     event_thread_t *p_ev = (event_thread_t *) p_this;
353     access_t *p_access = (access_t *) p_ev->p_access;
354     access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
355     int result = 0;
356
357     AVCPlay( p_access, p_sys->i_node );
358
359     vlc_thread_ready( p_this );
360
361     while( !p_sys->p_ev->b_die )
362     {
363         while( ( result = poll( &(p_sys->raw1394_poll), 1, 200 ) ) < 0 )
364         {
365             if( !( errno == EAGAIN || errno == EINTR ) )
366             {
367                 perror( "error: raw1394 poll" );
368                 msg_Err( p_access, "retrying device raw1394" );
369             }
370             if( p_sys->p_ev->b_die )
371                 break;
372         }
373         if( p_sys->p_ev->b_die )
374                 break;
375         if( result > 0 && ( ( p_sys->raw1394_poll.revents & POLLIN )
376                 || ( p_sys->raw1394_poll.revents & POLLPRI ) ) )
377             result = raw1394_loop_iterate( p_sys->p_raw1394 );
378     }
379
380     AVCStop( p_access, p_sys->i_node );
381     return VLC_SUCCESS;
382 }
383
384 static int Raw1394Handler( raw1394handle_t handle, int channel, size_t length, quadlet_t *data )
385 {
386     access_t *p_access = NULL;
387     access_sys_t *p_sys = NULL;
388     block_t *p_block = NULL;
389
390     p_access = (access_t *) raw1394_get_userdata( handle );
391     if( !p_access ) return 0;
392
393     p_sys = p_access->p_sys;
394
395     /* skip empty packets */
396     if ( length > 16 )
397     {
398         unsigned char * p = ( unsigned char* ) &data[ 3 ];
399         int section_type = p[ 0 ] >> 5;           /* section type is in bits 5 - 7 */
400         int dif_sequence = p[ 1 ] >> 4;           /* dif sequence number is in bits 4 - 7 */
401         int dif_block = p[ 2 ];
402
403         vlc_mutex_lock( &p_sys->p_ev->lock );
404
405         /* if we are at the beginning of a frame, we put the previous
406            frame in our output_queue. */
407         if( (section_type == 0) && (dif_sequence == 0) )
408         {
409             vlc_mutex_lock( &p_sys->lock );
410             if( p_sys->p_ev->p_frame )
411             {
412                 /* Push current frame to p_access thread. */
413                 //p_sys->p_ev->p_frame->i_pts = mdate();
414                 block_ChainAppend( &p_sys->p_frame, p_sys->p_ev->p_frame );
415             }
416             /* reset list */
417             p_sys->p_ev->p_frame = block_New( p_access, 144000 );
418             p_sys->p_ev->pp_last = &p_sys->p_frame;
419             vlc_mutex_unlock( &p_sys->lock );
420         }
421
422         p_block = p_sys->p_ev->p_frame;
423         if( p_block )
424         {
425             switch ( section_type )
426             {
427             case 0:    /* 1 Header block */
428                 /* p[3] |= 0x80; // hack to force PAL data */
429                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80, p, 480 );
430                 break;
431
432             case 1:    /* 2 Subcode blocks */
433                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 1 + dif_block ) * 80, p, 480 );
434                 break;
435
436             case 2:    /* 3 VAUX blocks */
437                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 3 + dif_block ) * 80, p, 480 );
438                 break;
439
440             case 3:    /* 9 Audio blocks interleaved with video */
441                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 6 + dif_block * 16 ) * 80, p, 480 );
442                 break;
443
444             case 4:    /* 135 Video blocks interleaved with audio */
445                 memcpy( p_block->p_buffer + dif_sequence * 150 * 80 + ( 7 + ( dif_block / 15 ) + dif_block ) * 80, p, 480 );
446                 break;
447
448             default:    /* we canĀ“t handle any other data */
449                 block_Release( p_block );
450                 p_block = NULL;
451                 break;
452             }
453         }
454         vlc_mutex_unlock( &p_sys->p_ev->lock );
455     }
456     return 0;
457 }
458
459 /*
460  * Routing borrowed from dvgrab-1.8
461  * Copyright by Arne Schirmacher <dvgrab@schirmacher.de>
462  * Dan Dennedy <dan@dennedy.org> and others
463  */
464 static int Raw1394GetNumPorts( access_t *p_access )
465 {
466     int n_ports;
467     struct raw1394_portinfo pinf[ 16 ];
468     raw1394handle_t handle;
469
470     /* get a raw1394 handle */
471     if ( !( handle = raw1394_new_handle() ) )
472     {
473         msg_Err( p_access, "raw1394 - failed to get handle: %s.\n", strerror( errno ) );
474         return VLC_EGENERIC;
475     }
476
477     if ( ( n_ports = raw1394_get_port_info( handle, pinf, 16 ) ) < 0 )
478     {
479         msg_Err( p_access, "raw1394 - failed to get port info: %s.\n", strerror( errno ) );
480         raw1394_destroy_handle( handle );
481         return VLC_EGENERIC;
482     }
483     raw1394_destroy_handle( handle );
484
485     return n_ports;
486 }
487
488 static raw1394handle_t Raw1394Open( access_t *p_access, int port )
489 {
490     int n_ports;
491     struct raw1394_portinfo pinf[ 16 ];
492     raw1394handle_t handle;
493
494     /* get a raw1394 handle */
495 #ifdef RAW1394_V_0_8
496
497     handle = raw1394_get_handle();
498 #else
499
500     handle = raw1394_new_handle();
501 #endif
502
503     if ( !handle )
504     {
505         msg_Err( p_access, "raw1394 - failed to get handle: %s.\n", strerror( errno ) );
506         return NULL;
507     }
508
509     if ( ( n_ports = raw1394_get_port_info( handle, pinf, 16 ) ) < 0 )
510     {
511         msg_Err( p_access, "raw1394 - failed to get port info: %s.\n", strerror( errno ) );
512         raw1394_destroy_handle( handle );
513         return NULL;
514     }
515
516     /* tell raw1394 which host adapter to use */
517     if ( raw1394_set_port( handle, port ) < 0 )
518     {
519         msg_Err( p_access, "raw1394 - failed to set set port: %s.\n", strerror( errno ) );
520         return NULL;
521     }
522
523     return handle;
524 }
525
526 static void Raw1394Close( raw1394handle_t handle )
527 {
528     raw1394_destroy_handle( handle );
529 }
530
531 static int DiscoverAVC( access_t *p_access, int* port, uint64_t guid )
532 {
533     rom1394_directory rom_dir;
534     raw1394handle_t handle = NULL;
535     int device = -1;
536     int i, j = 0;
537     int m = Raw1394GetNumPorts( p_access );
538
539     if( *port >= 0 )
540     {
541         /* search on explicit port */
542         j = *port;
543         m = *port + 1;
544     }
545
546     for( ; j < m && device == -1; j++ )
547     {
548         handle = Raw1394Open( p_access, j );
549         if( !handle )
550             return -1;
551
552         for( i = 0; i < raw1394_get_nodecount( handle ); ++i )
553         {
554             if( guid != 0 )
555             {
556                 /* select explicitly by GUID */
557                 if( guid == rom1394_get_guid( handle, i ) )
558                 {
559                     device = i;
560                     *port = j;
561                     break;
562                 }
563             }
564             else
565             {
566                 /* select first AV/C Tape Reccorder Player node */
567                 if( rom1394_get_directory( handle, i, &rom_dir ) < 0 )
568                 {
569                     msg_Err( p_access, "error reading config rom directory for node %d\n", i );
570                     continue;
571                 }
572                 if( ( rom1394_get_node_type( &rom_dir ) == ROM1394_NODE_TYPE_AVC ) &&
573                         avc1394_check_subunit_type( handle, i, AVC1394_SUBUNIT_TYPE_VCR ) )
574                 {
575                     device = i;
576                     *port = j;
577                     break;
578                 }
579             }
580         }
581         Raw1394Close( handle );
582     }
583
584     return device;
585 }
586
587 /*
588  * Handle AVC commands
589  */
590 static raw1394handle_t AVCOpen( access_t *p_access, int port )
591 {
592     access_sys_t *p_sys = p_access->p_sys;
593     int numcards;
594     struct raw1394_portinfo pinf[ 16 ];
595
596     p_sys->p_avc1394 = raw1394_new_handle();
597     if( !p_sys->p_avc1394 )
598         return NULL;
599
600     numcards = raw1394_get_port_info( p_sys->p_avc1394, pinf, 16 );
601     if( numcards < -1 )
602         return NULL;
603     if( raw1394_set_port( p_sys->p_avc1394, port ) < 0 )
604         return NULL;
605
606     raw1394_set_bus_reset_handler( p_sys->p_avc1394, AVCResetHandler );
607
608     return  p_sys->p_avc1394;
609 }
610
611 static void AVCClose( access_t *p_access )
612 {
613     access_sys_t *p_sys = p_access->p_sys;
614
615     if( p_sys->p_avc1394 )
616     {
617         raw1394_destroy_handle( p_sys->p_avc1394 );
618         p_sys->p_avc1394 = NULL;
619     }
620 }
621
622
623 static int AVCResetHandler( raw1394handle_t handle, unsigned int generation )
624 {
625     raw1394_update_generation( handle, generation );
626     return 0;
627 }
628
629 static int AVCPlay( access_t *p_access, int phyID )
630 {
631     access_sys_t *p_sys = p_access->p_sys;
632
633     msg_Dbg( p_access, "send play command over Digital Video control channel" );
634     if( !p_sys->p_avc1394 )
635         return 0;
636
637     if( phyID >= 0 )
638     {
639         if( !avc1394_vcr_is_recording( p_sys->p_avc1394, phyID ) &&
640             avc1394_vcr_is_playing( p_sys->p_avc1394, phyID ) != AVC1394_VCR_OPERAND_PLAY_FORWARD )
641                 avc1394_vcr_play( p_sys->p_avc1394, phyID );
642     }
643     return 0;
644 }
645
646 static int AVCPause( access_t *p_access, int phyID )
647 {
648     access_sys_t *p_sys = p_access->p_sys;
649
650     if( !p_sys->p_avc1394 )
651         return 0;
652
653     if( phyID >= 0 )
654     {
655         if( !avc1394_vcr_is_recording( p_sys->p_avc1394, phyID ) &&
656             ( avc1394_vcr_is_playing( p_sys->p_avc1394, phyID ) != AVC1394_VCR_OPERAND_PLAY_FORWARD_PAUSE ) )
657                 avc1394_vcr_pause( p_sys->p_avc1394, phyID );
658     }
659     return 0;
660 }
661
662
663 static int AVCStop( access_t *p_access, int phyID )
664 {
665     access_sys_t *p_sys = p_access->p_sys;
666
667     msg_Dbg( p_access, "closing Digital Video control channel" );
668     if( !p_sys->p_avc1394 )
669         return 0;
670
671     if ( phyID >= 0 )
672         avc1394_vcr_stop( p_sys->p_avc1394, phyID );
673
674     return 0;
675 }