1 /*****************************************************************************
2 * snapshot.h : vout internal snapshot
3 *****************************************************************************
4 * Copyright (C) 2009 Laurent Aimar
7 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef LIBVLC_VOUT_INTERNAL_SNAPSHOT_H
25 #define LIBVLC_VOUT_INTERNAL_SNAPSHOT_H
27 #include <vlc_picture.h>
40 void vout_snapshot_Init(vout_snapshot_t
*);
41 void vout_snapshot_Clean(vout_snapshot_t
*);
43 void vout_snapshot_End(vout_snapshot_t
*);
46 picture_t
*vout_snapshot_Get(vout_snapshot_t
*, mtime_t timeout
);
49 * It tells if they are pending snapshot request
51 bool vout_snapshot_IsRequested(vout_snapshot_t
*);
54 * It set the picture used to create the snapshots.
56 * The given picture is only copied and not released.
57 * If p_fmt is non NULL it will override the format of the p_picture (mainly
58 * used because of aspect/crop problems).
60 void vout_snapshot_Set(vout_snapshot_t
*, const video_format_t
*, const picture_t
*);
63 * This function will return the directory used for snapshots
65 char *vout_snapshot_GetDirectory(void);
73 } vout_snapshot_save_cfg_t
;
76 * This function will write an image to the disk an return the file name created.
78 int vout_snapshot_SaveImage(char **name
, int *sequential
,
80 vout_thread_t
*p_vout
,
81 const vout_snapshot_save_cfg_t
*cfg
);