X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_input.h;h=6ec305bebad2dd0cb1a29d4cd50168e09a53d375;hb=6515826a931516e57db9e8042294996cbeeadf73;hp=7d1d248162167b948a3a9cab42f4c6b54872252e;hpb=12256be1f21c0eeb5aadb69397c50063ba38a088;p=vlc diff --git a/include/vlc_input.h b/include/vlc_input.h index 7d1d248162..6ec305beba 100644 --- a/include/vlc_input.h +++ b/include/vlc_input.h @@ -1,25 +1,25 @@ /***************************************************************************** * vlc_input.h: Core input structures ***************************************************************************** - * Copyright (C) 1999-2006 the VideoLAN team + * Copyright (C) 1999-2006 VLC authors and VideoLAN * $Id$ * * Authors: Christophe Massiot * Laurent Aimar * - * 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 + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 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. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser 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 - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ /* __ is need because conflict with */ @@ -36,45 +36,10 @@ #include #include #include +#include #include -/***************************************************************************** - * Meta data helpers - *****************************************************************************/ -static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst, - const vlc_meta_t *p_meta ) -{ - const char * psz_value; - - if( !p_meta ) - return; - - if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) || - (psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) ) - { - p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true; - p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value ); - } - else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) || - (psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) ) - { - p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true; - p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value ); - } - else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) || - (psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) ) - { - p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true; - p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value ); - } - else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) ) - { - p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true; - p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value ); - } -} - /***************************************************************************** * Seek point: (generalisation of chapters) *****************************************************************************/ @@ -83,7 +48,6 @@ struct seekpoint_t int64_t i_byte_offset; int64_t i_time_offset; char *psz_name; - int i_level; }; static inline seekpoint_t *vlc_seekpoint_New( void ) @@ -91,7 +55,6 @@ static inline seekpoint_t *vlc_seekpoint_New( void ) seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) ); point->i_byte_offset = point->i_time_offset = -1; - point->i_level = 0; point->psz_name = NULL; return point; } @@ -115,7 +78,7 @@ static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src ) /***************************************************************************** * Title: *****************************************************************************/ -typedef struct +typedef struct input_title_t { char *psz_name; @@ -160,7 +123,7 @@ static inline void vlc_input_title_Delete( input_title_t *t ) free( t ); } -static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t ) +static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t ) { input_title_t *dup = vlc_input_title_New( ); int i; @@ -240,14 +203,6 @@ static inline void vlc_input_attachment_Delete( input_attachment_t *a ) * 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 -#define INPUT_UPDATE_META 0x0040 -#define INPUT_UPDATE_SIGNAL 0x0080 - /** * This defines private core storage for an input. */ @@ -310,7 +265,7 @@ struct input_thread_t * * The read-write variables are: * - state (\see input_state_e) - * - rate, rate-slower, rate-faster + * - rate * - position, position-offset * - time, time-offset * - title, next-title, prev-title @@ -346,7 +301,7 @@ typedef enum input_state_e * Input rate. * * It is an float used by the variable "rate" in the - * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MAX] + * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN] * the default value being 1. It represents the ratio of playback speed to * nominal speed (bigger is faster). * @@ -434,7 +389,7 @@ typedef enum input_event_type_e /* cache" has changed */ INPUT_EVENT_CACHE, - /* A aout_instance_t object has been created/deleted by *the input* */ + /* A audio_output_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, @@ -471,6 +426,13 @@ enum input_query_e INPUT_GET_SPU_DELAY, /* arg1 = int* res=can fail */ INPUT_SET_SPU_DELAY, /* arg1 = int res=can fail */ + /* Menu navigation */ + INPUT_NAV_ACTIVATE, + INPUT_NAV_UP, + INPUT_NAV_DOWN, + INPUT_NAV_LEFT, + INPUT_NAV_RIGHT, + /* Meta datas */ INPUT_ADD_INFO, /* arg1= char* arg2= char* arg3=... res=can fail */ INPUT_REPLACE_INFOS,/* arg1= info_category_t * res=cannot fail */ @@ -479,9 +441,6 @@ enum input_query_e INPUT_DEL_INFO, /* arg1= char* arg2= char* res=can fail */ INPUT_SET_NAME, /* arg1= char* res=can fail */ - /* Input config options */ - INPUT_ADD_OPTION, /* arg1= char * arg2= char * res=can fail*/ - /* Input properties */ INPUT_GET_VIDEO_FPS, /* arg1= double * res=can fail */ @@ -494,6 +453,9 @@ enum input_query_e INPUT_DEL_BOOKMARK, /* arg1= seekpoint_t * res=can fail */ INPUT_SET_BOOKMARK, /* arg1= int res=can fail */ + /* titles */ + INPUT_GET_TITLE_INFO, /* arg1=input_title_t** arg2= int * res=can fail */ + /* 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 */ @@ -511,9 +473,9 @@ enum input_query_e /* 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 */ - INPUT_GET_ES_OBJECTS, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, aout_instance_t ** */ + INPUT_GET_AOUT, /* arg1=audio_output_t ** res=can fail */ + INPUT_GET_VOUTS, /* arg1=vout_thread_t ***, size_t * res=can fail */ + INPUT_GET_ES_OBJECTS, /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */ /* External clock managments */ INPUT_GET_PCR_SYSTEM, /* arg1=mtime_t *, arg2=mtime_t * res=can fail */ @@ -526,22 +488,26 @@ enum input_query_e * Prototypes *****************************************************************************/ -VLC_EXPORT( input_thread_t *, input_Create, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) ); +VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED; #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d) -VLC_EXPORT( input_thread_t *, input_CreateAndStart, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) ); +VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED; #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c) -VLC_EXPORT( int, input_Start, ( input_thread_t * ) ); +VLC_API int input_Start( input_thread_t * ); -VLC_EXPORT( void, input_Stop, ( input_thread_t *, bool b_abort ) ); +VLC_API void input_Stop( input_thread_t *, bool b_abort ); -VLC_EXPORT( int, input_Read, ( vlc_object_t *, input_item_t * ) ); +VLC_API int input_Read( vlc_object_t *, input_item_t * ); #define input_Read(a,b) input_Read(VLC_OBJECT(a),b) -VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list ) ); +VLC_API int input_vaControl( input_thread_t *, int i_query, va_list ); + +VLC_API int input_Control( input_thread_t *, int i_query, ... ); -VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) ); +VLC_API void input_Close( input_thread_t * ); +void input_Join( input_thread_t * ); +void input_Release( input_thread_t * ); /** * Get the input item for an input thread @@ -549,7 +515,7 @@ VLC_EXPORT( int, input_Control, ( input_thread_t *, int i_query, ... ) ); * 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 * ) ); +VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED; /** * It will return the current state of the input. @@ -561,14 +527,6 @@ static inline input_state_e input_GetState( input_thread_t * p_input ) input_Control( p_input, INPUT_GET_STATE, &state ); return state; } -/** - * 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 ); -} /** * Return one of the video output (if any). If possible, you should use @@ -593,15 +551,38 @@ static inline vout_thread_t *input_GetVout( input_thread_t *p_input ) return p_vout; } +/** + * It will add a new subtitle source to the input. + * Provided for convenience. + */ +static inline int input_AddSubtitleOSD( input_thread_t *p_input, const char *psz_url, + bool b_check_extension, bool b_osd ) +{ + int i_result = input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension ); + if( i_result != VLC_SUCCESS || !b_osd ) + return i_result; + + vout_thread_t *p_vout = input_GetVout( p_input ); + if( p_vout ) + { + vout_OSDMessage(p_vout, SPU_DEFAULT_CHANNEL, "%s", + vlc_gettext("Subtitle track added") ); + vlc_object_release( (vlc_object_t *)p_vout ); + } + return i_result; +} +#define input_AddSubtitle(a, b, c) input_AddSubtitleOSD(a, b, c, false) + + /** * 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 ) +static inline audio_output_t *input_GetAout( input_thread_t *p_input ) { - aout_instance_t *p_aout; + audio_output_t *p_aout; return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout; } @@ -613,7 +594,7 @@ static inline aout_instance_t *input_GetAout( input_thread_t *p_input ) */ 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 ) + vout_thread_t **pp_vout, audio_output_t **pp_aout ) { return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id, pp_decoder, pp_vout, pp_aout ); @@ -635,24 +616,14 @@ static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolut } /* */ -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 * ) ); -VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) ); -VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t *, bool b_do_pace ) ); - -/** - * 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 ) ); +VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED; +VLC_API void input_DecoderDelete( decoder_t * ); +VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace ); /** * 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 ) ); +VLC_API char * input_CreateFilename( input_thread_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED; /** * It creates an empty input resource handler. @@ -660,16 +631,42 @@ VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path * The given object MUST stay alive as long as the input_resource_t is * not deleted. */ -VLC_EXPORT( input_resource_t *, input_resource_New, ( vlc_object_t * ) ); +VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED; /** - * It deletes an input resource. + * It releases an input resource. */ -VLC_EXPORT(void, input_resource_Delete, ( input_resource_t * ) ); +VLC_API void input_resource_Release( input_resource_t * ); /** * Forcefully destroys the video output (e.g. when the playlist is stopped). */ -VLC_EXPORT(void, input_resource_TerminateVout, ( input_resource_t * ) ); +VLC_API void input_resource_TerminateVout( input_resource_t * ); + +/** + * This function releases all resources (object). + */ +VLC_API void input_resource_Terminate( input_resource_t * ); + +/** + * \return the current audio output if any. + * Use vlc_object_release() to drop the reference. + */ +VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * ); + +/** + * This function creates or recycles an audio output. + */ +VLC_API audio_output_t *input_resource_GetAout( input_resource_t * ); + +/** + * This function retains or destroys an audio output. + */ +VLC_API void input_resource_PutAout( input_resource_t *, audio_output_t * ); + +/** + * Prevents the existing audio output (if any) from being recycled. + */ +VLC_API void input_resource_ResetAout( input_resource_t * ); #endif