2004-06-22 21:29:37 +02:00
|
|
|
/*****************************************************************************
|
2005-12-15 12:37:45 +01:00
|
|
|
* vlc_input.h: Core input structures
|
2004-06-22 21:29:37 +02:00
|
|
|
*****************************************************************************
|
2006-09-23 17:47:53 +02:00
|
|
|
* Copyright (C) 1999-2006 the VideoLAN team
|
2005-12-14 17:34:46 +01:00
|
|
|
* $Id$
|
2004-06-22 21:29:37 +02:00
|
|
|
*
|
|
|
|
* Authors: Christophe Massiot <massiot@via.ecp.fr>
|
|
|
|
* Laurent Aimar <fenrir@via.ecp.fr>
|
|
|
|
*
|
|
|
|
* 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
|
2006-01-13 00:10:04 +01:00
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
2004-06-22 21:29:37 +02:00
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
/* __ is need because conflict with <vlc/input.h> */
|
2008-08-11 18:13:10 +02:00
|
|
|
#ifndef VLC__INPUT_H
|
|
|
|
#define VLC__INPUT_H 1
|
2004-06-22 21:29:37 +02:00
|
|
|
|
2008-08-11 17:31:57 +02:00
|
|
|
/**
|
|
|
|
* \file
|
|
|
|
* This file defines functions, structures and enums for input objects in vlc
|
|
|
|
*/
|
|
|
|
|
2006-11-06 22:03:33 +01:00
|
|
|
#include <vlc_es.h>
|
2006-05-14 20:29:00 +02:00
|
|
|
#include <vlc_meta.h>
|
2007-03-23 20:55:17 +01:00
|
|
|
#include <vlc_epg.h>
|
2007-08-15 16:54:03 +02:00
|
|
|
#include <vlc_events.h>
|
2009-01-17 17:59:40 +01:00
|
|
|
#include <vlc_input_item.h>
|
2006-05-14 20:29:00 +02:00
|
|
|
|
2009-01-17 17:59:40 +01:00
|
|
|
#include <string.h>
|
2006-05-14 20:29:00 +02:00
|
|
|
|
2007-06-17 15:54:20 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Meta data helpers
|
|
|
|
*****************************************************************************/
|
|
|
|
static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
|
|
|
|
const vlc_meta_t *p_meta )
|
|
|
|
{
|
2010-01-06 16:04:12 +01:00
|
|
|
const char * psz_value;
|
2007-08-13 19:28:24 +02:00
|
|
|
|
2007-06-17 15:54:20 +02:00
|
|
|
if( !p_meta )
|
|
|
|
return;
|
|
|
|
|
2010-01-06 16:04:12 +01:00
|
|
|
if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) ||
|
|
|
|
(psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) )
|
2007-06-17 15:54:20 +02:00
|
|
|
{
|
2008-04-14 00:08:29 +02:00
|
|
|
p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
|
2007-08-13 19:28:24 +02:00
|
|
|
p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
|
|
|
|
}
|
2010-01-06 16:04:12 +01:00
|
|
|
else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) ||
|
|
|
|
(psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) )
|
2007-08-13 19:28:24 +02:00
|
|
|
{
|
2008-04-14 00:08:29 +02:00
|
|
|
p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
|
2007-08-13 19:28:24 +02:00
|
|
|
p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
|
|
|
|
}
|
2010-01-06 16:04:12 +01:00
|
|
|
else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) ||
|
|
|
|
(psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) )
|
2007-08-13 19:28:24 +02:00
|
|
|
{
|
2008-04-14 00:08:29 +02:00
|
|
|
p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
|
2007-08-13 19:28:24 +02:00
|
|
|
p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
|
|
|
|
}
|
2010-01-06 16:04:12 +01:00
|
|
|
else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) )
|
2007-08-13 19:28:24 +02:00
|
|
|
{
|
2008-04-14 00:08:29 +02:00
|
|
|
p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
|
2007-08-13 19:28:24 +02:00
|
|
|
p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
|
2007-06-17 15:54:20 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2004-06-22 21:29:37 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Seek point: (generalisation of chapters)
|
|
|
|
*****************************************************************************/
|
|
|
|
struct seekpoint_t
|
|
|
|
{
|
|
|
|
int64_t i_byte_offset;
|
|
|
|
int64_t i_time_offset;
|
|
|
|
char *psz_name;
|
2005-02-14 10:38:51 +01:00
|
|
|
int i_level;
|
2004-06-22 21:29:37 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
static inline seekpoint_t *vlc_seekpoint_New( void )
|
|
|
|
{
|
|
|
|
seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
|
|
|
|
point->i_byte_offset =
|
2005-03-07 21:16:52 +01:00
|
|
|
point->i_time_offset = -1;
|
2005-02-14 10:38:51 +01:00
|
|
|
point->i_level = 0;
|
2004-06-22 21:29:37 +02:00
|
|
|
point->psz_name = NULL;
|
|
|
|
return point;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void vlc_seekpoint_Delete( seekpoint_t *point )
|
|
|
|
{
|
|
|
|
if( !point ) return;
|
2008-03-11 22:18:20 +01:00
|
|
|
free( point->psz_name );
|
2004-06-22 21:29:37 +02:00
|
|
|
free( point );
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
|
|
|
|
{
|
|
|
|
seekpoint_t *point = vlc_seekpoint_New();
|
|
|
|
if( src->psz_name ) point->psz_name = strdup( src->psz_name );
|
|
|
|
point->i_time_offset = src->i_time_offset;
|
|
|
|
point->i_byte_offset = src->i_byte_offset;
|
|
|
|
return point;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
* Title:
|
|
|
|
*****************************************************************************/
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
char *psz_name;
|
|
|
|
|
2008-06-14 10:00:42 +02:00
|
|
|
bool b_menu; /* Is it a menu or a normal entry */
|
2004-06-22 21:29:37 +02:00
|
|
|
|
|
|
|
int64_t i_length; /* Length(microsecond) if known, else 0 */
|
|
|
|
int64_t i_size; /* Size (bytes) if known, else 0 */
|
|
|
|
|
|
|
|
/* Title seekpoint */
|
|
|
|
int i_seekpoint;
|
|
|
|
seekpoint_t **seekpoint;
|
|
|
|
|
|
|
|
} input_title_t;
|
|
|
|
|
2006-10-21 19:28:22 +02:00
|
|
|
static inline input_title_t *vlc_input_title_New(void)
|
2004-06-22 21:29:37 +02:00
|
|
|
{
|
|
|
|
input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
|
|
|
|
|
|
|
|
t->psz_name = NULL;
|
2008-04-14 00:08:29 +02:00
|
|
|
t->b_menu = false;
|
2004-06-22 21:29:37 +02:00
|
|
|
t->i_length = 0;
|
|
|
|
t->i_size = 0;
|
|
|
|
t->i_seekpoint = 0;
|
|
|
|
t->seekpoint = NULL;
|
|
|
|
|
|
|
|
return t;
|
|
|
|
}
|
2004-09-19 21:22:04 +02:00
|
|
|
|
2004-06-22 21:29:37 +02:00
|
|
|
static inline void vlc_input_title_Delete( input_title_t *t )
|
|
|
|
{
|
|
|
|
int i;
|
|
|
|
if( t == NULL )
|
|
|
|
return;
|
|
|
|
|
2008-03-11 22:18:20 +01:00
|
|
|
free( t->psz_name );
|
2004-06-22 21:29:37 +02:00
|
|
|
for( i = 0; i < t->i_seekpoint; i++ )
|
|
|
|
{
|
2008-03-11 22:18:20 +01:00
|
|
|
free( t->seekpoint[i]->psz_name );
|
2004-06-22 21:29:37 +02:00
|
|
|
free( t->seekpoint[i] );
|
|
|
|
}
|
2008-03-11 22:18:20 +01:00
|
|
|
free( t->seekpoint );
|
2004-06-22 21:29:37 +02:00
|
|
|
free( t );
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
|
|
|
|
{
|
|
|
|
input_title_t *dup = vlc_input_title_New( );
|
|
|
|
int i;
|
|
|
|
|
|
|
|
if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
|
|
|
|
dup->b_menu = t->b_menu;
|
|
|
|
dup->i_length = t->i_length;
|
|
|
|
dup->i_size = t->i_size;
|
|
|
|
dup->i_seekpoint = t->i_seekpoint;
|
|
|
|
if( t->i_seekpoint > 0 )
|
|
|
|
{
|
|
|
|
dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
|
|
|
|
sizeof(seekpoint_t*) );
|
|
|
|
|
|
|
|
for( i = 0; i < t->i_seekpoint; i++ )
|
|
|
|
{
|
|
|
|
dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return dup;
|
|
|
|
}
|
2008-06-14 10:00:42 +02:00
|
|
|
|
2007-05-31 21:22:27 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Attachments
|
|
|
|
*****************************************************************************/
|
|
|
|
struct input_attachment_t
|
|
|
|
{
|
|
|
|
char *psz_name;
|
|
|
|
char *psz_mime;
|
|
|
|
char *psz_description;
|
2004-06-22 21:29:37 +02:00
|
|
|
|
2007-05-31 21:22:27 +02:00
|
|
|
int i_data;
|
|
|
|
void *p_data;
|
|
|
|
};
|
2008-06-14 10:00:42 +02:00
|
|
|
|
2007-05-31 21:22:27 +02:00
|
|
|
static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
|
|
|
|
const char *psz_mime,
|
|
|
|
const char *psz_description,
|
|
|
|
const void *p_data,
|
|
|
|
int i_data )
|
|
|
|
{
|
|
|
|
input_attachment_t *a =
|
|
|
|
(input_attachment_t*)malloc( sizeof(input_attachment_t) );
|
|
|
|
if( !a )
|
|
|
|
return NULL;
|
|
|
|
a->psz_name = strdup( psz_name ? psz_name : "" );
|
|
|
|
a->psz_mime = strdup( psz_mime ? psz_mime : "" );
|
|
|
|
a->psz_description = strdup( psz_description ? psz_description : "" );
|
|
|
|
a->i_data = i_data;
|
|
|
|
a->p_data = NULL;
|
|
|
|
if( i_data > 0 )
|
|
|
|
{
|
|
|
|
a->p_data = malloc( i_data );
|
|
|
|
if( a->p_data && p_data )
|
|
|
|
memcpy( a->p_data, p_data, i_data );
|
|
|
|
}
|
|
|
|
return a;
|
|
|
|
}
|
|
|
|
static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
|
|
|
|
{
|
|
|
|
return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
|
|
|
|
a->p_data, a->i_data );
|
|
|
|
}
|
|
|
|
static inline void vlc_input_attachment_Delete( input_attachment_t *a )
|
|
|
|
{
|
|
|
|
if( !a )
|
|
|
|
return;
|
|
|
|
free( a->psz_name );
|
|
|
|
free( a->psz_mime );
|
|
|
|
free( a->psz_description );
|
2008-03-11 22:18:20 +01:00
|
|
|
free( a->p_data );
|
2007-05-31 21:22:27 +02:00
|
|
|
free( a );
|
|
|
|
}
|
2008-06-14 10:00:42 +02:00
|
|
|
|
2004-06-22 21:29:37 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* input defines/constants.
|
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
/* i_update field of access_t/demux_t */
|
|
|
|
#define INPUT_UPDATE_NONE 0x0000
|
|
|
|
#define INPUT_UPDATE_SIZE 0x0001
|
|
|
|
#define INPUT_UPDATE_TITLE 0x0010
|
|
|
|
#define INPUT_UPDATE_SEEKPOINT 0x0020
|
2004-08-25 20:50:36 +02:00
|
|
|
#define INPUT_UPDATE_META 0x0040
|
2008-09-23 22:11:01 +02:00
|
|
|
#define INPUT_UPDATE_SIGNAL 0x0080
|
2004-06-22 21:29:37 +02:00
|
|
|
|
2009-05-08 02:03:05 +02:00
|
|
|
/**
|
|
|
|
* This defines private core storage for an input.
|
2008-11-22 11:37:58 +01:00
|
|
|
*/
|
2006-11-26 15:20:34 +01:00
|
|
|
typedef struct input_thread_private_t input_thread_private_t;
|
|
|
|
|
2009-05-08 02:03:05 +02:00
|
|
|
/**
|
|
|
|
* This defines an opaque input resource handler.
|
|
|
|
*/
|
|
|
|
typedef struct input_resource_t input_resource_t;
|
|
|
|
|
2006-11-26 15:20:34 +01:00
|
|
|
/**
|
|
|
|
* Main structure representing an input thread. This structure is mostly
|
|
|
|
* private. The only public fields are READ-ONLY. You must use the helpers
|
|
|
|
* to modify them
|
|
|
|
*/
|
2004-06-22 21:29:37 +02:00
|
|
|
struct input_thread_t
|
|
|
|
{
|
2010-01-18 18:45:13 +01:00
|
|
|
VLC_COMMON_MEMBERS
|
2004-06-22 21:29:37 +02:00
|
|
|
|
2010-01-28 20:19:12 +01:00
|
|
|
bool b_error;
|
2008-09-14 13:42:23 +02:00
|
|
|
bool b_eof;
|
2008-04-14 00:08:29 +02:00
|
|
|
bool b_preparsing;
|
2008-09-14 13:42:23 +02:00
|
|
|
bool b_dead;
|
2006-11-26 18:27:16 +01:00
|
|
|
|
2006-11-26 15:20:34 +01:00
|
|
|
/* All other data is input_thread is PRIVATE. You can't access it
|
|
|
|
* outside of src/input */
|
|
|
|
input_thread_private_t *p;
|
2004-06-22 21:29:37 +02:00
|
|
|
};
|
|
|
|
|
2008-12-09 21:06:12 +01:00
|
|
|
/**
|
|
|
|
* Record prefix string.
|
|
|
|
* TODO make it configurable.
|
|
|
|
*/
|
2009-03-29 14:09:07 +02:00
|
|
|
#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
|
2008-12-09 21:06:12 +01:00
|
|
|
|
2008-11-22 16:26:16 +01:00
|
|
|
/*****************************************************************************
|
|
|
|
* Input events and variables
|
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* \defgroup inputvariable Input variables
|
|
|
|
*
|
|
|
|
* The input provides multiples variable you can write to and/or read from.
|
|
|
|
*
|
|
|
|
* TODO complete the documentation.
|
|
|
|
* The read only variables are:
|
|
|
|
* - "length"
|
2008-11-23 15:29:49 +01:00
|
|
|
* - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
|
2008-11-22 16:26:16 +01:00
|
|
|
* or not, for that check position != 0.0)
|
|
|
|
* - "can-pause"
|
2008-11-23 13:09:02 +01:00
|
|
|
* - "can-rate"
|
2008-11-22 16:26:16 +01:00
|
|
|
* - "can-rewind"
|
|
|
|
* - "can-record" (if a stream can be recorded while playing)
|
2009-02-13 20:41:51 +01:00
|
|
|
* - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
|
|
|
|
* variable value being the one currently selected, -1 if no teletext)
|
2008-11-23 13:09:02 +01:00
|
|
|
* - "signal-quality"
|
|
|
|
* - "signal-strength"
|
2009-03-08 16:22:32 +01:00
|
|
|
* - "program-scrambled" (if the current program is scrambled)
|
2008-12-04 22:54:29 +01:00
|
|
|
* - "cache" (level of data cached [0 .. 1])
|
2008-11-22 16:26:16 +01:00
|
|
|
*
|
|
|
|
* The read-write variables are:
|
|
|
|
* - state (\see input_state_e)
|
|
|
|
* - rate, rate-slower, rate-faster
|
|
|
|
* - position, position-offset
|
|
|
|
* - time, time-offset
|
2008-11-23 13:09:02 +01:00
|
|
|
* - title, next-title, prev-title
|
|
|
|
* - chapter, next-chapter, next-chapter-prev
|
2008-11-22 16:26:16 +01:00
|
|
|
* - program, audio-es, video-es, spu-es
|
|
|
|
* - audio-delay, spu-delay
|
2008-12-03 23:58:10 +01:00
|
|
|
* - bookmark (bookmark list)
|
2008-11-23 13:09:02 +01:00
|
|
|
* - record
|
|
|
|
* - frame-next
|
|
|
|
* - navigation (list of "title %2i")
|
|
|
|
* - "title %2i"
|
2008-11-22 16:26:16 +01:00
|
|
|
*
|
|
|
|
* The variable used for event is
|
|
|
|
* - intf-event (\see input_event_type_e)
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Input state
|
|
|
|
*
|
|
|
|
* This enum is used by the variable "state"
|
|
|
|
*/
|
|
|
|
typedef enum input_state_e
|
|
|
|
{
|
|
|
|
INIT_S = 0,
|
|
|
|
OPENING_S,
|
|
|
|
PLAYING_S,
|
|
|
|
PAUSE_S,
|
|
|
|
END_S,
|
|
|
|
ERROR_S,
|
|
|
|
} input_state_e;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Input rate.
|
|
|
|
*
|
2009-11-23 17:44:52 +01:00
|
|
|
* It is an float used by the variable "rate" in the
|
|
|
|
* range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MAX]
|
|
|
|
* the default value being 1. It represents the ratio of playback speed to
|
|
|
|
* nominal speed (bigger is faster).
|
2008-11-22 16:26:16 +01:00
|
|
|
*
|
2009-11-23 17:44:52 +01:00
|
|
|
* Internally, the rate is stored as a value in the range
|
|
|
|
* [INPUT_RATE_MIN, INPUT_RATE_MAX].
|
|
|
|
* internal rate = INPUT_RATE_DEFAULT / rate variable
|
2008-11-22 16:26:16 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Default rate value
|
|
|
|
*/
|
|
|
|
#define INPUT_RATE_DEFAULT 1000
|
|
|
|
/**
|
|
|
|
* Minimal rate value
|
|
|
|
*/
|
|
|
|
#define INPUT_RATE_MIN 32 /* Up to 32/1 */
|
|
|
|
/**
|
|
|
|
* Maximal rate value
|
|
|
|
*/
|
|
|
|
#define INPUT_RATE_MAX 32000 /* Up to 1/32 */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Input events
|
|
|
|
*
|
|
|
|
* You can catch input event by adding a callback on the variable "intf-event".
|
|
|
|
* This variable is an integer that will hold a input_event_type_e value.
|
|
|
|
*/
|
|
|
|
typedef enum input_event_type_e
|
|
|
|
{
|
|
|
|
/* "state" has changed */
|
|
|
|
INPUT_EVENT_STATE,
|
2008-12-23 12:07:51 +01:00
|
|
|
/* b_dead is true */
|
|
|
|
INPUT_EVENT_DEAD,
|
2009-03-09 20:38:46 +01:00
|
|
|
/* a *user* abort has been requested */
|
|
|
|
INPUT_EVENT_ABORT,
|
2008-12-23 12:07:51 +01:00
|
|
|
|
2008-11-22 16:26:16 +01:00
|
|
|
/* "rate" has changed */
|
|
|
|
INPUT_EVENT_RATE,
|
2008-12-23 12:07:51 +01:00
|
|
|
|
2009-05-11 22:17:54 +02:00
|
|
|
/* At least one of "position" or "time" */
|
|
|
|
INPUT_EVENT_POSITION,
|
|
|
|
|
|
|
|
/* "length" has changed */
|
|
|
|
INPUT_EVENT_LENGTH,
|
2008-11-22 16:26:16 +01:00
|
|
|
|
|
|
|
/* A title has been added or removed or selected.
|
|
|
|
* It imply that chapter has changed (not chapter event is sent) */
|
|
|
|
INPUT_EVENT_TITLE,
|
|
|
|
/* A chapter has been added or removed or selected. */
|
|
|
|
INPUT_EVENT_CHAPTER,
|
|
|
|
|
2009-03-08 16:22:32 +01:00
|
|
|
/* A program ("program") has been added or removed or selected,
|
|
|
|
* or "program-scrambled" has changed.*/
|
2008-11-22 16:26:16 +01:00
|
|
|
INPUT_EVENT_PROGRAM,
|
|
|
|
/* A ES has been added or removed or selected */
|
|
|
|
INPUT_EVENT_ES,
|
2008-11-23 14:29:50 +01:00
|
|
|
/* "teletext-es" has changed */
|
|
|
|
INPUT_EVENT_TELETEXT,
|
2008-11-22 16:26:16 +01:00
|
|
|
|
|
|
|
/* "record" has changed */
|
|
|
|
INPUT_EVENT_RECORD,
|
|
|
|
|
|
|
|
/* input_item_t media has changed */
|
|
|
|
INPUT_EVENT_ITEM_META,
|
|
|
|
/* input_item_t info has changed */
|
|
|
|
INPUT_EVENT_ITEM_INFO,
|
|
|
|
/* input_item_t name has changed */
|
|
|
|
INPUT_EVENT_ITEM_NAME,
|
2009-12-20 16:21:15 +01:00
|
|
|
/* input_item_t epg has changed */
|
|
|
|
INPUT_EVENT_ITEM_EPG,
|
2008-11-22 16:26:16 +01:00
|
|
|
|
|
|
|
/* Input statistics have been updated */
|
|
|
|
INPUT_EVENT_STATISTICS,
|
|
|
|
/* At least one of "signal-quality" or "signal-strength" has changed */
|
|
|
|
INPUT_EVENT_SIGNAL,
|
|
|
|
|
|
|
|
/* "audio-delay" has changed */
|
|
|
|
INPUT_EVENT_AUDIO_DELAY,
|
|
|
|
/* "spu-delay" has changed */
|
|
|
|
INPUT_EVENT_SUBTITLE_DELAY,
|
|
|
|
|
2008-12-03 23:58:10 +01:00
|
|
|
/* "bookmark" has changed */
|
|
|
|
INPUT_EVENT_BOOKMARK,
|
|
|
|
|
2008-12-04 22:54:29 +01:00
|
|
|
/* cache" has changed */
|
|
|
|
INPUT_EVENT_CACHE,
|
|
|
|
|
2008-12-27 12:25:18 +01:00
|
|
|
/* A aout_instance_t object has been created/deleted by *the input* */
|
|
|
|
INPUT_EVENT_AOUT,
|
|
|
|
/* A vout_thread_t object has been created/deleted by *the input* */
|
|
|
|
INPUT_EVENT_VOUT,
|
|
|
|
|
2008-11-22 16:26:16 +01:00
|
|
|
} input_event_type_e;
|
|
|
|
|
2009-03-09 20:38:46 +01:00
|
|
|
/**
|
2009-05-08 02:03:05 +02:00
|
|
|
* Input queries
|
2009-03-09 20:38:46 +01:00
|
|
|
*/
|
2004-06-22 21:29:37 +02:00
|
|
|
enum input_query_e
|
|
|
|
{
|
|
|
|
/* input variable "position" */
|
|
|
|
INPUT_GET_POSITION, /* arg1= double * res= */
|
|
|
|
INPUT_SET_POSITION, /* arg1= double res=can fail */
|
|
|
|
|
|
|
|
/* input variable "length" */
|
|
|
|
INPUT_GET_LENGTH, /* arg1= int64_t * res=can fail */
|
|
|
|
|
|
|
|
/* input variable "time" */
|
|
|
|
INPUT_GET_TIME, /* arg1= int64_t * res= */
|
|
|
|
INPUT_SET_TIME, /* arg1= int64_t res=can fail */
|
|
|
|
|
2009-11-23 17:44:52 +01:00
|
|
|
/* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
|
2004-06-22 21:29:37 +02:00
|
|
|
INPUT_GET_RATE, /* arg1= int * res= */
|
|
|
|
INPUT_SET_RATE, /* arg1= int res=can fail */
|
|
|
|
|
|
|
|
/* input variable "state" */
|
|
|
|
INPUT_GET_STATE, /* arg1= int * res= */
|
|
|
|
INPUT_SET_STATE, /* arg1= int res=can fail */
|
|
|
|
|
2005-02-15 21:29:29 +01:00
|
|
|
/* input variable "audio-delay" and "sub-delay" */
|
2004-06-23 19:49:26 +02:00
|
|
|
INPUT_GET_AUDIO_DELAY, /* arg1 = int* res=can fail */
|
|
|
|
INPUT_SET_AUDIO_DELAY, /* arg1 = int res=can fail */
|
|
|
|
INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */
|
|
|
|
INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */
|
|
|
|
|
|
|
|
/* Meta datas */
|
2005-04-26 09:19:10 +02:00
|
|
|
INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */
|
|
|
|
INPUT_GET_INFO, /* arg1= char* arg2= char* arg3= char** res=can fail */
|
|
|
|
INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */
|
|
|
|
INPUT_SET_NAME, /* arg1= char* res=can fail */
|
2004-06-23 19:49:26 +02:00
|
|
|
|
2004-08-05 14:45:23 +02:00
|
|
|
/* Input config options */
|
|
|
|
INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/
|
|
|
|
|
|
|
|
/* Input properties */
|
2007-10-01 01:17:19 +02:00
|
|
|
INPUT_GET_VIDEO_FPS, /* arg1= double * res=can fail */
|
2004-08-05 14:45:23 +02:00
|
|
|
|
2004-06-22 21:29:37 +02:00
|
|
|
/* bookmarks */
|
2008-12-02 20:01:02 +01:00
|
|
|
INPUT_GET_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
|
2004-06-22 21:29:37 +02:00
|
|
|
INPUT_GET_BOOKMARKS, /* arg1= seekpoint_t *** arg2= int * res=can fail */
|
|
|
|
INPUT_CLEAR_BOOKMARKS, /* res=can fail */
|
|
|
|
INPUT_ADD_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
|
|
|
|
INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail */
|
|
|
|
INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */
|
|
|
|
INPUT_SET_BOOKMARK, /* arg1= int res=can fail */
|
2004-11-22 10:52:06 +01:00
|
|
|
|
2007-05-31 21:22:27 +02:00
|
|
|
/* Attachments */
|
|
|
|
INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int* res=can fail */
|
|
|
|
INPUT_GET_ATTACHMENT, /* arg1=input_attachment_t**, arg2=char* res=can fail */
|
|
|
|
|
2004-11-22 10:52:06 +01:00
|
|
|
/* On the fly input slave */
|
2008-12-08 20:54:28 +01:00
|
|
|
INPUT_ADD_SLAVE, /* arg1= const char * */
|
|
|
|
INPUT_ADD_SUBTITLE, /* arg1= const char *, arg2=bool b_check_extension */
|
2008-08-26 12:54:18 +02:00
|
|
|
|
|
|
|
/* On the fly record while playing */
|
|
|
|
INPUT_SET_RECORD_STATE, /* arg1=bool res=can fail */
|
|
|
|
INPUT_GET_RECORD_STATE, /* arg1=bool* res=can fail */
|
2008-08-28 14:30:02 +02:00
|
|
|
|
|
|
|
/* ES */
|
|
|
|
INPUT_RESTART_ES, /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
|
2008-12-27 12:25:18 +01:00
|
|
|
|
|
|
|
/* Input ressources
|
|
|
|
* XXX You must call vlc_object_release as soon as possible */
|
|
|
|
INPUT_GET_AOUT, /* arg1=aout_instance_t ** res=can fail */
|
|
|
|
INPUT_GET_VOUTS, /* arg1=vout_thread_t ***, int * res=can fail */
|
2010-01-31 01:39:41 +01:00
|
|
|
INPUT_GET_ES_OBJECTS, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, aout_instance_t ** */
|
2010-02-01 21:21:11 +01:00
|
|
|
|
|
|
|
/* External clock managments */
|
|
|
|
INPUT_GET_PCR_SYSTEM, /* arg1=mtime_t * res=can fail */
|
|
|
|
INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t res=can fail */
|
2004-06-22 21:29:37 +02:00
|
|
|
};
|
|
|
|
|
2009-05-08 02:03:05 +02:00
|
|
|
/** @}*/
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
* Prototypes
|
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
#define input_Create(a,b,c,d) __input_Create(VLC_OBJECT(a),b,c,d)
|
|
|
|
VLC_EXPORT( input_thread_t *, __input_Create, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) );
|
|
|
|
|
|
|
|
#define input_CreateAndStart(a,b,c) __input_CreateAndStart(VLC_OBJECT(a),b,c)
|
|
|
|
VLC_EXPORT( input_thread_t *, __input_CreateAndStart, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) );
|
|
|
|
|
|
|
|
VLC_EXPORT( int, input_Start, ( input_thread_t * ) );
|
|
|
|
|
|
|
|
VLC_EXPORT( void, input_Stop, ( input_thread_t *, bool b_abort ) );
|
|
|
|
|
2009-09-14 23:15:24 +02:00
|
|
|
#define input_Read(a,b) __input_Read(VLC_OBJECT(a),b)
|
|
|
|
VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t * ) );
|
2009-05-08 02:03:05 +02:00
|
|
|
|
2004-06-22 21:29:37 +02:00
|
|
|
VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) );
|
2009-05-08 02:03:05 +02:00
|
|
|
|
2004-06-22 21:29:37 +02:00
|
|
|
VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) );
|
|
|
|
|
2009-05-08 02:03:05 +02:00
|
|
|
/**
|
|
|
|
* Get the input item for an input thread
|
|
|
|
*
|
|
|
|
* You have to keep a reference to the input or to the input_item_t until
|
|
|
|
* you do not need it anymore.
|
|
|
|
*/
|
|
|
|
VLC_EXPORT( input_item_t*, input_GetItem, ( input_thread_t * ) );
|
|
|
|
|
2008-12-08 20:54:28 +01:00
|
|
|
/**
|
|
|
|
* It will return the current state of the input.
|
|
|
|
* Provided for convenience.
|
|
|
|
*/
|
2008-08-02 02:37:56 +02:00
|
|
|
static inline input_state_e input_GetState( input_thread_t * p_input )
|
|
|
|
{
|
|
|
|
input_state_e state = INIT_S;
|
|
|
|
input_Control( p_input, INPUT_GET_STATE, &state );
|
|
|
|
return state;
|
|
|
|
}
|
2008-12-08 20:54:28 +01:00
|
|
|
/**
|
|
|
|
* It will add a new subtitle source to the input.
|
|
|
|
* Provided for convenience.
|
|
|
|
*/
|
|
|
|
static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
|
|
|
|
{
|
|
|
|
return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
|
|
|
|
}
|
2008-09-27 21:32:57 +02:00
|
|
|
|
2009-01-19 17:46:53 +01:00
|
|
|
/**
|
|
|
|
* Return one of the video output (if any). If possible, you should use
|
|
|
|
* INPUT_GET_VOUTS directly and process _all_ video outputs instead.
|
|
|
|
* @param p_input an input thread from which to get a video output
|
|
|
|
* @return NULL on error, or a video output thread pointer (which needs to be
|
|
|
|
* released with vlc_object_release()).
|
|
|
|
*/
|
|
|
|
static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
|
|
|
|
{
|
|
|
|
vout_thread_t **pp_vout, *p_vout;
|
2009-08-15 16:08:41 +02:00
|
|
|
size_t i_vout;
|
2009-01-19 17:46:53 +01:00
|
|
|
|
|
|
|
if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
|
|
|
|
return NULL;
|
|
|
|
|
2009-08-15 16:08:41 +02:00
|
|
|
for( size_t i = 1; i < i_vout; i++ )
|
2009-01-19 17:46:53 +01:00
|
|
|
vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
|
|
|
|
|
|
|
|
p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
|
2009-05-08 02:03:05 +02:00
|
|
|
free( pp_vout );
|
2009-01-19 17:46:53 +01:00
|
|
|
return p_vout;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the audio output (if any) associated with an input.
|
|
|
|
* @param p_input an input thread
|
|
|
|
* @return NULL on error, or the audio output (which needs to be
|
|
|
|
* released with vlc_object_release()).
|
|
|
|
*/
|
|
|
|
static inline aout_instance_t *input_GetAout( input_thread_t *p_input )
|
|
|
|
{
|
|
|
|
aout_instance_t *p_aout;
|
2009-01-19 18:36:59 +01:00
|
|
|
return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
|
2009-01-19 17:46:53 +01:00
|
|
|
}
|
|
|
|
|
2010-01-31 01:39:41 +01:00
|
|
|
/**
|
|
|
|
* Returns the objects associated to an ES.
|
|
|
|
*
|
|
|
|
* You must release all non NULL object using vlc_object_release.
|
|
|
|
* You may set pointer of pointer to NULL to avoid retreiving it.
|
|
|
|
*/
|
|
|
|
static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
|
|
|
|
vlc_object_t **pp_decoder,
|
|
|
|
vout_thread_t **pp_vout, aout_instance_t **pp_aout )
|
|
|
|
{
|
|
|
|
return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
|
|
|
|
pp_decoder, pp_vout, pp_aout );
|
|
|
|
}
|
|
|
|
|
2010-02-01 21:21:11 +01:00
|
|
|
/**
|
|
|
|
* \see input_clock_GetSystemOrigin
|
|
|
|
*/
|
|
|
|
static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system )
|
|
|
|
{
|
|
|
|
return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system );
|
|
|
|
}
|
|
|
|
/**
|
|
|
|
* \see input_clock_ChangeSystemOrigin
|
|
|
|
*/
|
|
|
|
static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
|
|
|
|
{
|
|
|
|
return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
|
|
|
|
}
|
|
|
|
|
2008-12-08 20:54:28 +01:00
|
|
|
/* */
|
2008-09-27 21:32:57 +02:00
|
|
|
typedef struct input_clock_t input_clock_t;
|
|
|
|
VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, input_clock_t *, sout_instance_t * ) );
|
2004-06-22 21:29:37 +02:00
|
|
|
VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
|
2009-04-27 21:07:00 +02:00
|
|
|
VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t *, bool b_do_pace ) );
|
2004-06-22 21:29:37 +02:00
|
|
|
|
2008-08-22 02:23:43 +02:00
|
|
|
/**
|
|
|
|
* This function allows to split a MRL into access, demux and path part.
|
|
|
|
*
|
|
|
|
* You should not write into access and demux string as they may not point into
|
|
|
|
* the provided buffer.
|
|
|
|
* The buffer provided by psz_dup will be modified.
|
|
|
|
*/
|
|
|
|
VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );
|
|
|
|
|
2008-12-09 21:06:12 +01:00
|
|
|
/**
|
|
|
|
* This function creates a sane filename path.
|
|
|
|
*/
|
|
|
|
VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) );
|
|
|
|
|
2009-08-25 19:11:06 +02:00
|
|
|
/**
|
|
|
|
* This function detaches resources from a dead input.
|
|
|
|
*
|
|
|
|
* It MUST be called on a dead input (p_input->b_dead true) otherwise
|
|
|
|
* it will assert.
|
|
|
|
* It does not support concurrent calls.
|
|
|
|
*/
|
|
|
|
VLC_EXPORT(input_resource_t *, input_DetachResource, ( input_thread_t * ) );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This function releases the input resource.
|
|
|
|
*/
|
|
|
|
VLC_EXPORT(void, input_resource_Delete, ( input_resource_t * ) );
|
|
|
|
|
2004-06-22 21:29:37 +02:00
|
|
|
#endif
|