]> git.sesse.net Git - vlc/blobdiff - src/video_output/vout_intf.c
Partially cleanup the vout_window API
[vlc] / src / video_output / vout_intf.c
index 7ed2ab47d830bc430cc2006e394579b134a33652..e4dd70ce47d373d05d6fa2616f001be00046ca64 100644 (file)
 #include <stdio.h>
 #include <stdlib.h>                                                /* free() */
 #include <sys/types.h>                                          /* opendir() */
+#include <sys/stat.h>
 #include <dirent.h>                                             /* opendir() */
 #include <assert.h>
+#include <time.h>                                           /* strftime */
 
 #include <vlc_interface.h>
 #include <vlc_block.h>
@@ -49,6 +51,7 @@
 #include <vlc_strings.h>
 #include <vlc_charset.h>
 #include "../libvlc.h"
+#include "vout_internal.h"
 
 /*****************************************************************************
  * Local prototypes
@@ -76,21 +79,27 @@ static int TitleTimeoutCallback( vlc_object_t *, char const *,
 static int TitlePositionCallback( vlc_object_t *, char const *,
                                   vlc_value_t, vlc_value_t, void * );
 
-/*****************************************************************************
- * vout_RequestWindow: Create/Get a video window if possible.
- *****************************************************************************
- * This function looks for the main interface and tries to request
- * a new video window. If it fails then the vout will still need to create the
- * window by itself.
- *****************************************************************************/
-void *vout_RequestWindow( vout_thread_t *p_vout,
+/**
+ * Creates a video output window.
+ * On Unix systems, this is an X11 drawable (handle).
+ * On Windows, this is a Win32 window (handle).
+ * Video output plugins are supposed to called this function and display the
+ * video within the resulting window, while in windowed mode.
+ *
+ * @param p_vout video output thread to create a window for
+ * @param pi_x_hint pointer to store the recommended horizontal position [OUT]
+ * @param pi_y_hint pointer to store the recommended vertical position [OUT]
+ * @param pi_width_hint pointer to store the recommended width [OUT]
+ * @param pi_height_hint pointer to store the recommended height [OUT]
+ *
+ * @return a vout_window_t object, or NULL in case of failure.
+ * The window is released with vout_ReleaseWindow().
+ */
+vout_window_t *vout_RequestWindow( vout_thread_t *p_vout,
                           int *pi_x_hint, int *pi_y_hint,
                           unsigned int *pi_width_hint,
                           unsigned int *pi_height_hint )
 {
-    /* Small kludge */
-    if( !var_Type( p_vout, "aspect-ratio" ) ) vout_IntfInit( p_vout );
-
     /* Get requested coordinates */
     *pi_x_hint = var_GetInteger( p_vout, "video-x" );
     *pi_y_hint = var_GetInteger( p_vout, "video-y" );
@@ -114,42 +123,38 @@ void *vout_RequestWindow( vout_thread_t *p_vout,
     wnd->pos_y = *pi_y_hint;
     vlc_object_attach (wnd, p_vout);
 
-    wnd->module = module_Need (wnd, "vout window", 0, 0);
+    wnd->module = module_need (wnd, "vout_window", NULL, false);
     if (wnd->module == NULL)
     {
         msg_Dbg (wnd, "no window provider available");
         vlc_object_release (wnd);
         return NULL;
     }
-    p_vout->p_window = wnd;
     *pi_width_hint = wnd->width;
     *pi_height_hint = wnd->height;
     *pi_x_hint = wnd->pos_x;
     *pi_y_hint = wnd->pos_y;
-    return wnd->handle;
+    return wnd;
 }
 
-void vout_ReleaseWindow( vout_thread_t *p_vout, void *dummy )
+/**
+ * Releases a window handle obtained with vout_RequestWindow().
+ * @param p_vout video output thread that allocated the window
+ *               (if this is NULL; this fnction is a no-op).
+ */
+void vout_ReleaseWindow( vout_window_t *wnd )
 {
-    vout_window_t *wnd = p_vout->p_window;
-
     if (wnd == NULL)
         return;
-    p_vout->p_window = NULL;
 
     assert (wnd->module);
-    module_Unneed (wnd, wnd->module);
+    module_unneed (wnd, wnd->module);
 
     vlc_object_release (wnd);
-    (void)dummy;
 }
 
-int vout_ControlWindow( vout_thread_t *p_vout, void *dummy,
-                        int i_query, va_list args )
+int vout_ControlWindow( vout_window_t *wnd, int i_query, va_list args )
 {
-    (void)dummy;
-    vout_window_t *wnd = p_vout->p_window;
-
     if (wnd == NULL)
         return VLC_EGENERIC;
 
@@ -256,11 +261,12 @@ void vout_IntfInit( vout_thread_t *p_vout )
     var_Create( p_vout, "mouse-hide-timeout",
                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 
-    p_vout->b_title_show = var_CreateGetBool( p_vout, "video-title-show" );
-    p_vout->i_title_timeout =
+    p_vout->p->b_title_show = var_CreateGetBool( p_vout, "video-title-show" );
+    p_vout->p->i_title_timeout =
         (mtime_t)var_CreateGetInteger( p_vout, "video-title-timeout" );
-    p_vout->i_title_position =
+    p_vout->p->i_title_position =
         var_CreateGetInteger( p_vout, "video-title-position" );
+    p_vout->p->psz_title =  NULL;
 
     var_AddCallback( p_vout, "video-title-show", TitleShowCallback, NULL );
     var_AddCallback( p_vout, "video-title-timeout", TitleTimeoutCallback, NULL );
@@ -327,7 +333,7 @@ void vout_IntfInit( vout_thread_t *p_vout )
     var_AddCallback( p_vout, "crop", CropCallback, NULL );
     var_Get( p_vout, "crop", &old_val );
     if( old_val.psz_string && *old_val.psz_string )
-        var_Change( p_vout, "crop", VLC_VAR_TRIGGER_CALLBACKS, 0, 0 );
+        var_TriggerCallback( p_vout, "crop" );
     free( old_val.psz_string );
 
     /* Monitor pixel aspect-ratio */
@@ -351,14 +357,14 @@ void vout_IntfInit( vout_thread_t *p_vout )
         }
         if( !i_aspect_num || !i_aspect_den ) i_aspect_num = i_aspect_den = 1;
 
-        p_vout->i_par_num = i_aspect_num;
-        p_vout->i_par_den = i_aspect_den;
+        p_vout->p->i_par_num = i_aspect_num;
+        p_vout->p->i_par_den = i_aspect_den;
 
-        vlc_ureduce( &p_vout->i_par_num, &p_vout->i_par_den,
-                     p_vout->i_par_num, p_vout->i_par_den, 0 );
+        vlc_ureduce( &p_vout->p->i_par_num, &p_vout->p->i_par_den,
+                     p_vout->p->i_par_num, p_vout->p->i_par_den, 0 );
 
         msg_Dbg( p_vout, "overriding monitor pixel aspect-ratio: %i:%i",
-                 p_vout->i_par_num, p_vout->i_par_den );
+                 p_vout->p->i_par_num, p_vout->p->i_par_den );
         b_force_par = true;
     }
     free( val.psz_string );
@@ -388,7 +394,7 @@ void vout_IntfInit( vout_thread_t *p_vout )
     var_AddCallback( p_vout, "aspect-ratio", AspectCallback, NULL );
     var_Get( p_vout, "aspect-ratio", &old_val );
     if( (old_val.psz_string && *old_val.psz_string) || b_force_par )
-        var_Change( p_vout, "aspect-ratio", VLC_VAR_TRIGGER_CALLBACKS, 0, 0 );
+        var_TriggerCallback( p_vout, "aspect-ratio" );
     free( old_val.psz_string );
 
     /* Initialize the dimensions of the video window */
@@ -456,7 +462,7 @@ static int VoutSnapshotPip( vout_thread_t *p_vout, image_handler_t *p_image, pic
     if( !p_pip )
         return VLC_EGENERIC;
 
-    p_subpic = spu_CreateSubpicture( p_vout->p_spu );
+    p_subpic = subpicture_New();
     if( p_subpic == NULL )
     {
          picture_Release( p_pip );
@@ -474,10 +480,16 @@ static int VoutSnapshotPip( vout_thread_t *p_vout, image_handler_t *p_image, pic
     fmt_out.i_sar_num =
     fmt_out.i_sar_den = 0;
 
-    p_subpic->p_region = spu_CreateRegion( p_vout->p_spu, &fmt_out );
+    p_subpic->p_region = subpicture_region_New( &fmt_out );
     if( p_subpic->p_region )
-        vout_CopyPicture( p_image->p_parent, &p_subpic->p_region->picture, p_pip );
-    picture_Release( p_pip );
+    {
+        picture_Release( p_subpic->p_region->p_picture );
+        p_subpic->p_region->p_picture = p_pip;
+    }
+    else
+    {
+        picture_Release( p_pip );
+    }
 
     spu_DisplaySubpicture( p_vout->p_spu, p_subpic );
     return VLC_SUCCESS;
@@ -485,9 +497,9 @@ static int VoutSnapshotPip( vout_thread_t *p_vout, image_handler_t *p_image, pic
 /**
  * This function will return the default directory used for snapshots
  */
-static char *VoutSnapshotGetDefaultDirectory( vout_thread_t *p_vout )
+static char *VoutSnapshotGetDefaultDirectory( void )
 {
-    char *psz_path;
+    char *psz_path = NULL;
 #if defined(__APPLE__) || defined(SYS_BEOS)
 
     if( asprintf( &psz_path, "%s/Desktop",
@@ -560,20 +572,20 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
     DIR *path;
     int i_ret;
     bool b_embedded_snapshot;
-    uintmax_t i_id = (uintmax_t)NULL;
+    void *p_obj;
 
     /* */
     val.psz_string = var_GetNonEmptyString( p_vout, "snapshot-path" );
 
     /* Embedded snapshot : if snapshot-path == object:object_ptr */
-    if( val.psz_string && sscanf( val.psz_string, "object:%ju", &i_id ) > 0 )
+    if( val.psz_string && sscanf( val.psz_string, "object:%p", &p_obj ) > 0 )
         b_embedded_snapshot = true;
     else
         b_embedded_snapshot = false;
 
     /* */
     memset( &fmt_in, 0, sizeof(video_format_t) );
-    fmt_in = p_vout->fmt_in;
+    fmt_in = p_vout->fmt_out;
     if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
     {
         fmt_in.i_sar_num =
@@ -626,13 +638,12 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
      */
     if( b_embedded_snapshot )
     {
-        vlc_object_t* p_dest = (vlc_object_t *)(uintptr_t)i_id;
+        vlc_object_t* p_dest = p_obj;
         block_t *p_block;
         snapshot_t *p_snapshot;
         size_t i_size;
 
-        /* Object must be locked. We will unlock it once we get the
-           snapshot and written it to p_private */
+       vlc_object_lock( p_dest );
         p_dest->p_private = NULL;
 
         /* Save the snapshot to a memory zone */
@@ -641,8 +652,8 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
         {
             msg_Err( p_vout, "Could not get snapshot" );
             image_HandlerDelete( p_image );
-            vlc_object_signal( p_dest );
-            vlc_object_release( p_dest );
+            vlc_object_signal_unlocked( p_dest );
+           vlc_object_unlock( p_dest );
             return VLC_EGENERIC;
         }
 
@@ -653,8 +664,8 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
         {
             block_Release( p_block );
             image_HandlerDelete( p_image );
-            vlc_object_signal( p_dest );
-            vlc_object_release( p_dest );
+            vlc_object_signal_unlocked( p_dest );
+           vlc_object_unlock( p_dest );
             return VLC_ENOMEM;
         }
 
@@ -670,8 +681,8 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
             block_Release( p_block );
             free( p_snapshot );
             image_HandlerDelete( p_image );
-            vlc_object_signal( p_dest );
-            vlc_object_release( p_dest );
+            vlc_object_signal_unlocked( p_dest );
+           vlc_object_unlock( p_dest );
             return VLC_ENOMEM;
         }
         memcpy( p_snapshot->p_data, p_block->p_buffer, p_block->i_buffer );
@@ -681,8 +692,8 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
         block_Release( p_block );
 
         /* Unlock the object */
-        vlc_object_signal( p_dest );
-        vlc_object_release( p_dest );
+        vlc_object_signal_unlocked( p_dest );
+       vlc_object_unlock( p_dest );
 
         image_HandlerDelete( p_image );
         return VLC_SUCCESS;
@@ -690,7 +701,7 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
 
     /* Get default directory if none provided */
     if( !val.psz_string )
-        val.psz_string = VoutSnapshotGetDefaultDirectory( p_vout );
+        val.psz_string = VoutSnapshotGetDefaultDirectory( );
     if( !val.psz_string )
     {
         msg_Err( p_vout, "no path specified for snapshots" );
@@ -730,9 +741,11 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
         if( var_GetBool( p_vout, "snapshot-sequential" ) == true )
         {
             int i_num = var_GetInteger( p_vout, "snapshot-num" );
-            FILE *p_file;
+            struct stat st;
+
             do
             {
+                free( psz_filename );
                 if( asprintf( &psz_filename, "%s" DIR_SEP "%s%05d.%s",
                               val.psz_string, psz_prefix, i_num++,
                               format.psz_string ) == -1 )
@@ -742,22 +755,48 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
                     return VLC_EGENERIC;
                 }
             }
-            while( ( p_file = utf8_fopen( psz_filename, "r" ) ) && !fclose( p_file ) );
+            while( utf8_stat( psz_filename, &st ) == 0 );
+
             var_SetInteger( p_vout, "snapshot-num", i_num );
         }
         else
         {
-            if( asprintf( &psz_filename, "%s" DIR_SEP "%s%u.%s",
+            struct tm    curtime;
+            time_t        lcurtime ;
+            lcurtime = time( NULL ) ;
+            if ( ( localtime_r( &lcurtime, &curtime ) == NULL ) )
+            {
+                msg_Warn( p_vout, "failed to get current time. Falling back to legacy snapshot naming" );
+                /* failed to get current time. Fallback to old format */
+                if( asprintf( &psz_filename, "%s" DIR_SEP "%s%u.%s",
                           val.psz_string, psz_prefix,
                           (unsigned int)(p_pic->date / 100000) & 0xFFFFFF,
                           format.psz_string ) == -1 )
-            {
-                msg_Err( p_vout, "could not create snapshot" );
-                image_HandlerDelete( p_image );
-                return VLC_EGENERIC;
+                {
+                    msg_Err( p_vout, "could not create snapshot" );
+                    image_HandlerDelete( p_image );
+                    return VLC_EGENERIC;
+                }
             }
-        }
-
+            else
+            {
+                char psz_curtime[15] ;
+                if( strftime( psz_curtime, 15, "%y%m%d-%H%M%S", &curtime ) == 0 )
+                {
+                    msg_Warn( p_vout, "snapshot date string truncated" ) ;
+                }
+                if( asprintf( &psz_filename, "%s" DIR_SEP "%s%s%1u.%s",
+                      val.psz_string, psz_prefix, psz_curtime,
+                     /* suffix with the last decimal digit in 10s of seconds resolution */
+                     (unsigned int)(p_pic->date / (100*1000)) & 0xFF,
+                      format.psz_string ) == -1 )
+                {
+                    msg_Err( p_vout, "could not create snapshot" );
+                    image_HandlerDelete( p_image );
+                    return VLC_EGENERIC;
+                }
+            } //end if time() < 0
+        } //end snapshot sequential
         free( psz_prefix );
     }
     else // The user specified a full path name (including file name)
@@ -783,6 +822,14 @@ int vout_Snapshot( vout_thread_t *p_vout, picture_t *p_pic )
     msg_Dbg( p_vout, "snapshot taken (%s)", psz_filename );
     vout_OSDMessage( VLC_OBJECT( p_vout ), DEFAULT_CHAN,
                      "%s", psz_filename );
+
+    /* Generate a media player event  - Right now just trigger a global libvlc var
+        CHECK: Could not find a more local object. The goal is to communicate
+        vout_thread with libvlc_media_player or its input_thread*/
+    val.psz_string =  psz_filename  ;
+
+    var_Set( p_vout->p_libvlc, "vout-snapshottaken", val );
+    /* var_Set duplicates data for transport so we can free*/
     free( psz_filename );
 
     /* */
@@ -861,13 +908,8 @@ int vout_vaControlDefault( vout_thread_t *p_vout, int i_query, va_list args )
     (void)args;
     switch( i_query )
     {
-    case VOUT_REPARENT:
-    case VOUT_CLOSE:
-        vout_ReleaseWindow( p_vout, NULL );
-        return VLC_SUCCESS;
-
     case VOUT_SNAPSHOT:
-        p_vout->b_snapshot = true;
+        p_vout->p->b_snapshot = true;
         return VLC_SUCCESS;
 
     default:
@@ -1148,12 +1190,12 @@ static int AspectCallback( vlc_object_t *p_this, char const *psz_cmd,
     p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
 
  aspect_end:
-    if( p_vout->i_par_num && p_vout->i_par_den )
+    if( p_vout->p->i_par_num && p_vout->p->i_par_den )
     {
-        p_vout->fmt_in.i_sar_num *= p_vout->i_par_den;
-        p_vout->fmt_in.i_sar_den *= p_vout->i_par_num;
+        p_vout->fmt_in.i_sar_num *= p_vout->p->i_par_den;
+        p_vout->fmt_in.i_sar_den *= p_vout->p->i_par_num;
         p_vout->fmt_in.i_aspect = p_vout->fmt_in.i_aspect *
-            p_vout->i_par_den / p_vout->i_par_num;
+            p_vout->p->i_par_den / p_vout->p->i_par_num;
         p_vout->render.i_aspect = p_vout->fmt_in.i_aspect;
     }
 
@@ -1221,7 +1263,7 @@ static int TitleShowCallback( vlc_object_t *p_this, char const *psz_cmd,
     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
     VLC_UNUSED(p_data);
     vout_thread_t *p_vout = (vout_thread_t *)p_this;
-    p_vout->b_title_show = newval.b_bool;
+    p_vout->p->b_title_show = newval.b_bool;
     return VLC_SUCCESS;
 }
 
@@ -1230,7 +1272,7 @@ static int TitleTimeoutCallback( vlc_object_t *p_this, char const *psz_cmd,
 {
     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
     vout_thread_t *p_vout = (vout_thread_t *)p_this;
-    p_vout->i_title_timeout = (mtime_t) newval.i_int;
+    p_vout->p->i_title_timeout = (mtime_t) newval.i_int;
     return VLC_SUCCESS;
 }
 
@@ -1240,6 +1282,6 @@ static int TitlePositionCallback( vlc_object_t *p_this, char const *psz_cmd,
     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
     VLC_UNUSED(p_data);
     vout_thread_t *p_vout = (vout_thread_t *)p_this;
-    p_vout->i_title_position = newval.i_int;
+    p_vout->p->i_title_position = newval.i_int;
     return VLC_SUCCESS;
 }