vlc/include/vlc_demux.h

/*****************************************************************************
 * vlc_demux.h: Demuxer descriptor, queries and methods
 *****************************************************************************
 * Copyright (C) 1999-2005 VLC authors and VideoLAN
 *
 * Authors: 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 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 Lesser General Public License for more details.
 *
 * 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.
 *****************************************************************************/

#ifndef VLC_DEMUX_H
#define VLC_DEMUX_H 1

#include <stdlib.h>
#include <string.h>

#include <vlc_es.h>
#include <vlc_stream.h>
#include <vlc_es_out.h>

/**
 * \defgroup demux Demultiplexer
 * \ingroup input
 * Demultiplexers (file format parsers)
 * @{
 * \file
 * Demultiplexer modules interface
 */

/* pf_demux return values */
#define VLC_DEMUXER_EOF       0
#define VLC_DEMUXER_EGENERIC -1
#define VLC_DEMUXER_SUCCESS   1

/* DEMUX_TEST_AND_CLEAR flags */
#define INPUT_UPDATE_TITLE      0x0010
#define INPUT_UPDATE_SEEKPOINT  0x0020
#define INPUT_UPDATE_META       0x0040
#define INPUT_UPDATE_TITLE_LIST 0x0100

/* Demux module descriptor helpers */
#define add_file_extension(ext) add_shortcut("ext-" ext)

/* demux_meta_t is returned by "meta reader" module to the demuxer */
typedef struct demux_meta_t
{
    struct vlc_object_t obj;
    input_item_t *p_item; /***< the input item that is being read */

    vlc_meta_t *p_meta;                 /**< meta data */

    int i_attachments;                  /**< number of attachments */
    input_attachment_t **attachments;    /**< array of attachments */
} demux_meta_t;

/**
 * Control query identifiers for use with demux_t.pf_control
 *
 * In the individual identifier description, the input stream refers to
 * demux_t.s if non-NULL, and the output refers to demux_t.out.
 *
 * A demuxer is synchronous if it only accesses its input stream and the
 * output from within its demux_t callbacks, i.e. demux.pf_demux and
 * demux_t.pf_control.
 *
 * A demuxer is threaded if it accesses either or both input and output
 * asynchronously.
 *
 * An access-demuxer is a demuxer without input, i.e. demux_t.s == NULL).
 */
enum demux_query_e
{
    /** Checks whether the stream supports seeking.
     * Can fail if seeking is not supported (same as returning false).
     * \bug Failing should not be allowed.
     *
     * arg1 = bool * */
    DEMUX_CAN_SEEK,

    /** Checks whether (long) pause then stream resumption is supported.
     * Can fail only if synchronous and <b>not</b> an access-demuxer. The
     * underlying input stream then determines if pause is supported.
     * \bug Failing should not be allowed.
     *
     * arg1= bool * */
    DEMUX_CAN_PAUSE = 0x002,

    /** Whether the stream can be read at an arbitrary pace.
     * Cannot fail.
     *
     * arg1= bool * */
    DEMUX_CAN_CONTROL_PACE,

    /** Retrieves the PTS delay (roughly the default buffer duration).
     * Can fail only if synchronous and <b>not</b> an access-demuxer. The
     * underlying input stream then determines the PTS delay.
     *
     * arg1= vlc_tick_t * */
    DEMUX_GET_PTS_DELAY = 0x101,

    /** Retrieves stream meta-data.
     * Should fail if no meta-data were retrieved.
     *
     * arg1= vlc_meta_t * */
    DEMUX_GET_META = 0x105,

    /** Retrieves an estimate of signal quality and strength.
     * Can fail.
     *
     * arg1=double *quality, arg2=double *strength */
    DEMUX_GET_SIGNAL = 0x107,

    /** Retrieves the demuxed content type
     * Can fail if the control is not implemented
     *
     * arg1= int* */
    DEMUX_GET_TYPE = 0x109,

    /** Sets the paused or playing/resumed state.
     *
     * Streams are initially in playing state. The control always specifies a
     * change from paused to playing (false) or from playing to paused (true)
     * and streams are initially playing; a no-op cannot be requested.
     *
     * The control is never used if DEMUX_CAN_PAUSE fails.
     * Can fail.
     *
     * arg1= bool */
    DEMUX_SET_PAUSE_STATE = 0x200,

    /** Seeks to the beginning of a title.
     *
     * The control is never used if DEMUX_GET_TITLE_INFO fails.
     * Can fail.
     *
     * arg1= int */
    DEMUX_SET_TITLE,

    /** Seeks to the beginning of a chapter of the current title.
     *
     * The control is never used if DEMUX_GET_TITLE_INFO fails.
     * Can fail.
     *
     * arg1= int */
    DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */

    /** Check which INPUT_UPDATE_XXX flag is set and reset the ones set.
     *
     * The unsigned* argument is set with the flags needed to be checked,
     * on return it contains the values that were reset during the call
     *
     * arg1= unsigned * */
    DEMUX_TEST_AND_CLEAR_FLAGS, /* arg1= unsigned*      can fail */

    /** Read the title number currently playing
     *
     * Can fail.
     *
     * arg1= int * */
    DEMUX_GET_TITLE,            /* arg1= int*           can fail */

    /* Read the seekpoint/chapter currently playing
     *
     * Can fail.
     *
     * arg1= int * */
    DEMUX_GET_SEEKPOINT,        /* arg1= int*           can fail */

    /* I. Common queries to access_demux and demux */
    /* POSITION double between 0.0 and 1.0 */
    DEMUX_GET_POSITION = 0x300, /* arg1= double *       res=    */
    DEMUX_SET_POSITION,         /* arg1= double arg2= bool b_precise    res=can fail    */

    /* LENGTH/TIME in microsecond, 0 if unknown */
    DEMUX_GET_LENGTH,           /* arg1= vlc_tick_t *   res=    */
    DEMUX_GET_TIME,             /* arg1= vlc_tick_t *   res=    */
    DEMUX_SET_TIME,             /* arg1= vlc_tick_t arg2= bool b_precise   res=can fail    */
    /* Normal or original time, used mainly by the ts module */
    DEMUX_GET_NORMAL_TIME,      /* arg1= vlc_tick_t *   res= can fail, in that case VLC_TICK_0 will be used as NORMAL_TIME */

    /**
     * \todo Document
     *
     * \warning The prototype is different from STREAM_GET_TITLE_INFO
     *
     * Can fail, meaning there is only one title and one chapter.
     *
     * arg1= input_title_t ***, arg2=int *, arg3=int *pi_title_offset(0),
     * arg4= int *pi_seekpoint_offset(0) */
    DEMUX_GET_TITLE_INFO,

    /* DEMUX_SET_GROUP_* / DEMUX_SET_ES is only a hint for demuxer (mainly DVB)
     * to avoid parsing everything (you should not use this to call
     * es_out_Control()).
     * If you don't know what to do with it, just IGNORE it: it is safe(r). */
    DEMUX_SET_GROUP_DEFAULT,
    DEMUX_SET_GROUP_ALL,
    DEMUX_SET_GROUP_LIST,       /* arg1= size_t, arg2= const int *, can fail */
    DEMUX_SET_ES,               /* arg1= int                        can fail */
    DEMUX_SET_ES_LIST,          /* arg1= size_t, arg2= const int * (can be NULL) can fail */

    /* Ask the demux to demux until the given date at the next pf_demux call
     * but not more (and not less, at the precision available of course).
     * XXX: not mandatory (except for subtitle demux) but will help a lot
     * for multi-input
     */
    DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= vlc_tick_t     can fail */
    /* FPS for correct subtitles handling */
    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */

    /* Meta data */
    DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */

    /*
     * Fetches attachment from the demux.
     * The returned attachments are owned by the demuxer and must not be modified
     * arg1=input_attachment_t***, int* res=can fail
     */
    DEMUX_GET_ATTACHMENTS,

    /* RECORD you are ensured that it is never called twice with the same state
     * you should accept it only if the stream can be recorded without
     * any modification or header addition. */
    DEMUX_CAN_RECORD,           /* arg1=bool*   res=can fail(assume false) */
    /**
     * \todo Document
     *
     * \warning The prototype is different from STREAM_SET_RECORD_STATE
     *
     * The control is never used if DEMUX_CAN_RECORD fails or returns false.
     * Can fail.
     *
     * arg1= bool arg2= string */
    DEMUX_SET_RECORD_STATE,

    /* II. Specific access_demux queries */

    /* DEMUX_CAN_CONTROL_RATE is called only if DEMUX_CAN_CONTROL_PACE has
     *  returned false. *pb_rate should be true when the rate can be changed
     * (using DEMUX_SET_RATE). */
    DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate */
    /* DEMUX_SET_RATE is called only if DEMUX_CAN_CONTROL_RATE has returned true.
     * It should return the value really used in *p_rate */
    DEMUX_SET_RATE,             /* arg1= float*p_rate res=can fail */

    /* Menu (VCD/DVD/BD) Navigation */
    /** Activate the navigation item selected. Can fail */
    DEMUX_NAV_ACTIVATE,
    /** Use the up arrow to select a navigation item above. Can fail */
    DEMUX_NAV_UP,
    /** Use the down arrow to select a navigation item under. Can fail */
    DEMUX_NAV_DOWN,
    /** Use the left arrow to select a navigation item on the left. Can fail */
    DEMUX_NAV_LEFT,
    /** Use the right arrow to select a navigation item on the right. Can fail */
    DEMUX_NAV_RIGHT,
    /** Activate the popup Menu (for BD). Can fail */
    DEMUX_NAV_POPUP,
    /** Activate disc Root Menu. Can fail */
    DEMUX_NAV_MENU,            /* res=can fail */
    /** Enable/Disable a demux filter
     * \warning This has limited support, and is likely to break if more than
     * a single demux_filter is present in the chain. This is not guaranteed to
     * work in future VLC versions, nor with all demux filters
     */
    DEMUX_FILTER_ENABLE,
    DEMUX_FILTER_DISABLE
};

/*************************************************************************
 * Main Demux
 *************************************************************************/

VLC_API demux_t *demux_New( vlc_object_t *p_obj, const char *module_name,
                            const char *url, stream_t *s, es_out_t *out );

static inline void demux_Delete(demux_t *demux)
{
    vlc_stream_Delete(demux);
}

VLC_API int demux_vaControlHelper( stream_t *, int64_t i_start, int64_t i_end,
                                   int64_t i_bitrate, int i_align, int i_query, va_list args );

VLC_API int demux_Demux( demux_t *p_demux ) VLC_USED;
VLC_API int demux_vaControl( demux_t *p_demux, int i_query, va_list args );

static inline int demux_Control( demux_t *p_demux, int i_query, ... )
{
    va_list args;
    int     i_result;

    va_start( args, i_query );
    i_result = demux_vaControl( p_demux, i_query, args );
    va_end( args );
    return i_result;
}

/*************************************************************************
 * Miscellaneous helpers for demuxers
 *************************************************************************/

VLC_USED static inline bool vlc_demux_CanSeek(demux_t *demux)
{
    bool can_seek = false;
    demux_Control(demux, DEMUX_CAN_SEEK, &can_seek);
    return can_seek;
}

VLC_USED static inline bool vlc_demux_CanPause(demux_t *demux)
{
    bool can_pause = false;
    demux_Control(demux, DEMUX_CAN_PAUSE, &can_pause);
    return can_pause;
}

VLC_USED static inline bool vlc_demux_CanPace(demux_t *demux)
{
    bool can_control_pace = false;
    demux_Control(demux, DEMUX_CAN_CONTROL_PACE, &can_control_pace);
    return can_control_pace;
}

VLC_USED static inline bool vlc_demux_CanRate(demux_t *demux)
{
    bool can_control_rate = false;
    demux_Control(demux, DEMUX_CAN_CONTROL_RATE, &can_control_rate);
    return can_control_rate;
}

VLC_USED static inline bool vlc_demux_CanRecord(demux_t *demux)
{
    bool can_record = false;
    demux_Control(demux, DEMUX_CAN_RECORD, &can_record);
    return can_record;
}

VLC_USED static inline bool vlc_demux_HasUnsupportedMeta(demux_t *demux)
{
    bool has_unsupported_meta = false;
    demux_Control(demux, DEMUX_HAS_UNSUPPORTED_META, &has_unsupported_meta);
    return has_unsupported_meta;
}

VLC_USED static inline int vlc_demux_GetPtsDelay(demux_t *demux, vlc_tick_t *pts_delay)
{
    return demux_Control(demux, DEMUX_GET_PTS_DELAY, pts_delay);
}

VLC_USED static inline int vlc_demux_GetSeekpoint(demux_t *demux, int *seekpoint)
{
    return demux_Control(demux, DEMUX_GET_SEEKPOINT, seekpoint);
}

VLC_USED static inline int vlc_demux_GetSignal(demux_t *demux, double *quality, double *strength)
{
    return demux_Control(demux, DEMUX_GET_SIGNAL, quality, strength);
}

VLC_USED static inline int vlc_demux_GetTitle(demux_t *demux, int *title)
{
    return demux_Control(demux, DEMUX_GET_TITLE, title);
}

VLC_USED static inline int vlc_demux_GetMeta(demux_t *demux, vlc_meta_t *meta)
{
    return demux_Control(demux, DEMUX_GET_META, meta);
}

VLC_USED static inline int vlc_demux_GetType(demux_t *demux, int *type)
{
    return demux_Control(demux, DEMUX_GET_TYPE, type);
}

VLC_USED static inline int vlc_demux_GetTitleInfo(demux_t *demux, input_title_t ***title_info, int *size, int *pi_title_offset, int *pi_seekpoint_offset)
{
    return demux_Control(demux, DEMUX_GET_TITLE_INFO, title_info, size, pi_title_offset, pi_seekpoint_offset);
}

VLC_USED static inline int vlc_demux_GetPosition(demux_t *demux, double *position)
{
    return demux_Control(demux, DEMUX_GET_POSITION, position);
}

VLC_USED static inline int vlc_demux_GetLength(demux_t *demux, vlc_tick_t *length)
{
    return demux_Control(demux, DEMUX_GET_LENGTH, length);
}

VLC_USED static inline int vlc_demux_GetTime(demux_t *demux, vlc_tick_t *time)
{
    return demux_Control(demux, DEMUX_GET_TIME, time);
}

VLC_USED static inline int vlc_demux_GetNormalTime(demux_t *demux, vlc_tick_t *normal_time)
{
    return demux_Control(demux, DEMUX_GET_NORMAL_TIME, normal_time);
}

VLC_USED static inline int vlc_demux_GetFPS(demux_t *demux, double *fps)
{
    return demux_Control(demux, DEMUX_GET_FPS, fps);
}

VLC_USED static inline int vlc_demux_GetAttachments(demux_t *demux, input_attachment_t ***attachments)
{
    return demux_Control(demux, DEMUX_GET_ATTACHMENTS, attachments);
}

VLC_USED static inline int vlc_demux_SetPauseState(demux_t *demux, bool pause_state)
{
    return demux_Control(demux, DEMUX_SET_PAUSE_STATE, pause_state);
}

VLC_USED static inline int vlc_demux_SetSeekPoint(demux_t *demux, int seekpoint)
{
    return demux_Control(demux, DEMUX_SET_SEEKPOINT, seekpoint);
}

VLC_USED static inline int vlc_demux_SetTitle(demux_t *demux, int title)
{
    return demux_Control(demux, DEMUX_SET_TITLE, title);
}

VLC_USED static inline int vlc_demux_SetRate(demux_t *demux, float rate)
{
    return demux_Control(demux, DEMUX_SET_RATE, rate);
}

VLC_USED static inline int vlc_demux_SetRecordState(demux_t *demux, bool record_state, const char *dir_path, const char *ext)
{
    return demux_Control(demux, DEMUX_SET_RECORD_STATE, record_state, dir_path, ext);
}

VLC_USED static inline int vlc_demux_NavActivate(demux_t *demux)
{
    return demux_Control(demux, DEMUX_NAV_ACTIVATE);
}

VLC_USED static inline int vlc_demux_NavUp(demux_t *demux)
{
    return demux_Control(demux, DEMUX_NAV_UP);
}

VLC_USED static inline int vlc_demux_NavDown(demux_t *demux)
{
    return demux_Control(demux, DEMUX_NAV_DOWN);
}

VLC_USED static inline int vlc_demux_NavLeft(demux_t *demux)
{
    return demux_Control(demux, DEMUX_NAV_LEFT);
}

VLC_USED static inline int vlc_demux_NavRight(demux_t *demux)
{
    return demux_Control(demux, DEMUX_NAV_RIGHT);
}

VLC_USED static inline int vlc_demux_NavPopup(demux_t *demux)
{
    return demux_Control(demux, DEMUX_NAV_POPUP);
}

VLC_USED static inline int vlc_demux_NavMenu(demux_t *demux)
{
    return demux_Control(demux, DEMUX_NAV_MENU);
}

VLC_USED static inline int vlc_demux_FilterEnable(demux_t *demux)
{
    return demux_Control(demux, DEMUX_FILTER_ENABLE);
}

VLC_USED static inline int vlc_demux_FilterDisable(demux_t *demux)
{
    return demux_Control(demux, DEMUX_FILTER_DISABLE);
}

#ifndef __cplusplus
static inline void demux_UpdateTitleFromStream( demux_t *demux,
    int *restrict titlep, int *restrict seekpointp,
    unsigned *restrict updatep )
{
    stream_t *s = demux->s;
    unsigned title, seekpoint;

    if( vlc_stream_Control( s, STREAM_GET_TITLE, &title ) == VLC_SUCCESS
     && title != (unsigned)*titlep )
    {
        *titlep = title;
        *updatep |= INPUT_UPDATE_TITLE;
    }

    if( vlc_stream_Control( s, STREAM_GET_SEEKPOINT,
                            &seekpoint ) == VLC_SUCCESS
     && seekpoint != (unsigned)*seekpointp )
    {
        *seekpointp = seekpoint;
        *updatep |= INPUT_UPDATE_SEEKPOINT;
    }
}
# define demux_UpdateTitleFromStream(demux) \
     demux_UpdateTitleFromStream(demux, \
         &((demux_sys_t *)((demux)->p_sys))->current_title, \
         &((demux_sys_t *)((demux)->p_sys))->current_seekpoint, \
         &((demux_sys_t *)((demux)->p_sys))->updates)
#endif

VLC_USED
static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
{
    const char *name = (p_demux->psz_filepath != NULL) ? p_demux->psz_filepath
                                                       : p_demux->psz_location;
    const char *psz_ext = strrchr ( name, '.' );
    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
        return false;
    return true;
}

VLC_USED
static inline bool demux_IsContentType(demux_t *demux, const char *type)
{
    return stream_IsMimeType(demux->s, type);
}

VLC_USED
static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
{
   if( p_demux->psz_name == NULL || strcmp( p_demux->psz_name, psz_name ) )
        return false;
    return true;
}

static inline int demux_SetPosition( demux_t *p_demux, double pos, bool precise )
{
    if( pos < 0.f )
        pos = 0.f;
    else if( pos > 1.f )
        pos = 1.f;
    return demux_Control( p_demux, DEMUX_SET_POSITION, pos, precise );
}

static inline int demux_SetTime( demux_t *p_demux, vlc_tick_t time, bool precise )
{
    if( time < 0 )
        time = 0;
    return demux_Control( p_demux, DEMUX_SET_TIME, time, precise );
}

/**
 * This function will create a packetizer suitable for a demuxer that parses
 * elementary stream.
 *
 * The provided es_format_t will be cleaned on error or by
 * demux_PacketizerDestroy.
 */
VLC_API decoder_t * demux_PacketizerNew( vlc_object_t *p_demux, es_format_t *p_fmt, const char *psz_msg ) VLC_USED;

/**
 * This function will destroy a packetizer create by demux_PacketizerNew.
 */
VLC_API void demux_PacketizerDestroy( decoder_t *p_packetizer );

/* */
#define DEMUX_INIT_COMMON() do {            \
    p_demux->pf_read = NULL;                \
    p_demux->pf_block = NULL;               \
    p_demux->pf_seek = NULL;                \
    p_demux->pf_control = Control;          \
    p_demux->pf_demux = Demux;              \
    p_demux->p_sys = calloc( 1, sizeof( demux_sys_t ) ); \
    if( !p_demux->p_sys ) return VLC_ENOMEM;\
    } while(0)

/**
 * \defgroup chained_demux Chained demultiplexer
 * Demultiplexers wrapped by another demultiplexer
 * @{
 */

typedef struct vlc_demux_chained_t vlc_demux_chained_t;

/**
 * Creates a chained demuxer.
 *
 * This creates a thread running a demuxer whose input stream is generated
 * directly by the caller. This typically handles some sort of stream within a
 * stream, e.g. MPEG-TS within something else.
 *
 * \note There are a number of limitations to this approach. The chained
 * demuxer is run asynchronously in a separate thread. Most demuxer controls
 * are synchronous and therefore unavailable in this case. Also the input
 * stream is a simple FIFO, so the chained demuxer cannot perform seeks.
 * Lastly, most errors cannot be detected.
 *
 * \param parent parent VLC object
 * \param name chained demux module name (e.g. "ts")
 * \param out elementary stream output for the chained demux
 * \return a non-NULL pointer on success, NULL on failure.
 */
VLC_API vlc_demux_chained_t *vlc_demux_chained_New(vlc_object_t *parent,
                                                   const char *name,
                                                   es_out_t *out);

/**
 * Destroys a chained demuxer.
 *
 * Sends an end-of-stream to the chained demuxer, and releases all underlying
 * allocated resources.
 */
VLC_API void vlc_demux_chained_Delete(vlc_demux_chained_t *);

/**
 * Sends data to a chained demuxer.
 *
 * This queues data for a chained demuxer to consume.
 *
 * \param demux the chained demuxer instance to send the block to
 * \param block data block to queue
 */
VLC_API void vlc_demux_chained_Send(vlc_demux_chained_t *demux, block_t *block);

/**
 * Controls a chained demuxer.
 *
 * This performs a <b>demux</b> (i.e. DEMUX_...) control request on a chained
 * demux.
 *
 * \note In most cases, vlc_demux_chained_Control() should be used instead.
 * \warning As per vlc_demux_chained_New(), most demux controls are not, and
 * cannot be, supported; VLC_EGENERIC is returned.
 *
 * \param demux the chained demuxer instance to send the request to
 * \param query demux control (see \ref demux_query_e)
 * \param args variable arguments (depending on the query)
 */
VLC_API int vlc_demux_chained_ControlVa(vlc_demux_chained_t *demux,
                                        int query, va_list args);

static inline int vlc_demux_chained_Control(vlc_demux_chained_t *dc, int query,
                                            ...)
{
    va_list ap;
    int ret;

    va_start(ap, query);
    ret = vlc_demux_chained_ControlVa(dc, query, ap);
    va_end(ap);
    return ret;
}

/**
 * @}
 */

/**
 * @}
 */

#endif