Hacker Guide/Access - Revision history

DoesItReallyMatter: Format, copy-edit

2019-04-25T05:23:56Z

Format, copy-edit

DoesItReallyMatter: /* Functions to implement */ Replace git with doxygen

2019-04-25T05:09:59Z

Functions to implement: Replace git with doxygen

← Older revision		Revision as of 05:09, 25 April 2019
Line 30:		Line 30:
	After implementing Open() and Close() functions, you will need to implement a few majors features that will be implemented by your functions.		After implementing Open() and Close() functions, you will need to implement a few majors features that will be implemented by your functions.

	As you can see ~~{{VLCSourceFile\|~~include/vlc_access.h}}, you should define:		As you can see [https://www.videolan.org/developers/vlc/doc/doxygen/html/vlc__access_8h_source.html include/vlc_access.h], you should define:

	* Seek, as in pf_seek,		* Seek, as in pf_seek,

DoesItReallyMatter: +{{Back to|Hacker Guide}}

2019-04-17T06:36:52Z

+{{Back to|Hacker Guide}}

← Older revision		Revision as of 06:36, 17 April 2019
Line 1:		Line 1:
			{{Back to\|Hacker Guide}}
	== Description ==		== Description ==

DoesItReallyMatter: Rewrite wikilinks, drop name= in template

2019-02-15T20:47:31Z

Rewrite wikilinks, drop name= in template

← Older revision		Revision as of 20:47, 15 February 2019
Line 5:		Line 5:
	They take an [[MRL]] in, and output a bitstream, that can be fed to a [[Demuxer]].		They take an [[MRL]] in, and output a bitstream, that can be fed to a [[Demuxer]].

	Access input and [[~~Hacker Guide~~/Access Output\|output]] handles most of the basic '''I/O''' for VLC. They are usually '''protocols''' implementations (http, ftp,...) or '''devices''' access (Webcams, Capture cards).		Access input and [[{{#rel2abs:../Access Output}}\|output]] handles most of the basic '''I/O''' for VLC. They are usually '''protocols''' implementations (http, ftp,...) or '''devices''' access (Webcams, Capture cards).

	We will discuss about ''''input access'''' in this page.		We will discuss about ''''input access'''' in this page.
Line 11:		Line 11:
	== Write an access module ==		== Write an access module ==

	To write an access module, read first the [[~~Documentation~~:~~Hacker's Guide~~/Module ~~Writers Guide~~\|introduction to module writing]].		To write an access module, read first the [[{{#rel2abs:../How To Write a Module}}\|introduction to module writing]].

	Then, you should specify your module of being of access type:		Then, you should specify your module of being of access type:
Line 29:		Line 29:
	After implementing Open() and Close() functions, you will need to implement a few majors features that will be implemented by your functions.		After implementing Open() and Close() functions, you will need to implement a few majors features that will be implemented by your functions.

	As you can see {{VLCSourceFile\|~~name=~~include/vlc_access.h}}, you should define:		As you can see {{VLCSourceFile\|include/vlc_access.h}}, you should define:

	* Seek, as in pf_seek,		* Seek, as in pf_seek,

DoesItReallyMatter: /* Description */ Avoid redirect, links back to self, remove selflink; avoid redirect

2019-02-15T05:25:33Z

Description: Avoid redirect, links back to self, remove selflink; avoid redirect

← Older revision		Revision as of 05:25, 15 February 2019
Line 5:		Line 5:
	They take an [[MRL]] in, and output a bitstream, that can be fed to a [[Demuxer]].		They take an [[MRL]] in, and output a bitstream, that can be fed to a [[Demuxer]].

	Access ~~[[Documentation:Hacker's Guide/Access\|~~input]] and [[~~Documentation:~~Hacker's Guide/Access Output\|output]] handles most of the basic '''I/O''' for VLC. They are usually '''protocols''' implementations (http, ftp,...) or '''devices''' access (Webcams, Capture cards).		Access input and [[Hacker Guide/Access Output\|output]] handles most of the basic '''I/O''' for VLC. They are usually '''protocols''' implementations (http, ftp,...) or '''devices''' access (Webcams, Capture cards).

	We will discuss about ''''input access'''' in this page.		We will discuss about ''''input access'''' in this page.

DoesItReallyMatter: Relative URL fragments

2019-02-15T05:22:41Z

Relative URL fragments

← Older revision		Revision as of 05:22, 15 February 2019
Line 33:		Line 33:
	* Seek, as in pf_seek,		* Seek, as in pf_seek,
	* Control, as in pf_control,		* Control, as in pf_control,
	* Read or Block, depending on your module [[~~Hacker_Guide/Access~~#Type\|type]].		* Read or Block, depending on your module [[#Type\|type]].

	After implementing those functions, you should assign them to the corresponding pf_ function.		After implementing those functions, you should assign them to the corresponding pf_ function.

DoesItReallyMatter: Demote headings

2019-02-15T05:04:45Z

Demote headings

← Older revision		Revision as of 05:04, 15 February 2019
Line 1:		Line 1:
	= Description =		== Description ==

	The modules of ''''access'''' capability are designed to be the first and last elements of a modules chain.		The modules of ''''access'''' capability are designed to be the first and last elements of a modules chain.
Line 9:		Line 9:
	We will discuss about ''''input access'''' in this page.		We will discuss about ''''input access'''' in this page.

	= Write an access module =		== Write an access module ==

	To write an access module, read first the [[Documentation:Hacker's Guide/Module Writers Guide\|introduction to module writing]].		To write an access module, read first the [[Documentation:Hacker's Guide/Module Writers Guide\|introduction to module writing]].
Line 19:		Line 19:
	set_subcategory( SUBCAT_INPUT_ACCESS )		set_subcategory( SUBCAT_INPUT_ACCESS )

	== Type ==		=== Type ===
	Your module can be of either a ''''Block'''' or a ''''Read'''' type, depending on your medium:		Your module can be of either a ''''Block'''' or a ''''Read'''' type, depending on your medium:

Line 25:		Line 25:
	* if you can control the size of the data requested to the underlying protocol, '''Read''' is a better type.		* if you can control the size of the data requested to the underlying protocol, '''Read''' is a better type.

	= Functions to implement =		== Functions to implement ==

	After implementing Open() and Close() functions, you will need to implement a few majors features that will be implemented by your functions.		After implementing Open() and Close() functions, you will need to implement a few majors features that will be implemented by your functions.
Line 37:		Line 37:
	After implementing those functions, you should assign them to the corresponding pf_ function.		After implementing those functions, you should assign them to the corresponding pf_ function.

	== Seek ==		=== Seek ===

	''Prototype'':		''Prototype'':
Line 55:		Line 55:
	If the seek has succeeded, it should return VLC_SUCCESS, else it should return VLC_EGENERIC. <br>		If the seek has succeeded, it should return VLC_SUCCESS, else it should return VLC_EGENERIC. <br>

	== Control ==		=== Control ===

	''Prototype'':		''Prototype'':
Line 72:		Line 72:
	If the query has succeeded, it should return VLC_SUCCESS. Else it should return VLC_EGENERIC (''fail'').		If the query has succeeded, it should return VLC_SUCCESS. Else it should return VLC_EGENERIC (''fail'').

	=== Control Query types ===		==== Control Query types ====

	The first ones are request to know what the module supports. They are all of '''boolean''' type and should always succeed.		The first ones are request to know what the module supports. They are all of '''boolean''' type and should always succeed.
Line 100:		Line 100:
	You can find the list of arguments corresponding to query types in the comments of access_query_e definition in vlc_access.h		You can find the list of arguments corresponding to query types in the comments of access_query_e definition in vlc_access.h

	== Read ==		=== Read ===

	''Prototype'':		''Prototype'':
Line 110:		Line 110:
	Return -1 if no data yet, 0 if no more data, else actual data read on the medium.		Return -1 if no data yet, 0 if no more data, else actual data read on the medium.

	== Block ==		=== Block ===

	''Prototype'':		''Prototype'':

DoesItReallyMatter: /* Description */ Fix link I broke

2019-01-29T05:57:41Z

Description: Fix link I broke

← Older revision		Revision as of 05:57, 29 January 2019
Line 5:		Line 5:
	They take an [[MRL]] in, and output a bitstream, that can be fed to a [[Demuxer]].		They take an [[MRL]] in, and output a bitstream, that can be fed to a [[Demuxer]].

	Access [[Documentation:Hacker's Guide/Access\|input]] and [[Documentation:Hacker's Guide/Access ~~output~~\|output]] handles most of the basic '''I/O''' for VLC. They are usually '''protocols''' implementations (http, ftp,...) or '''devices''' access (Webcams, Capture cards).		Access [[Documentation:Hacker's Guide/Access\|input]] and [[Documentation:Hacker's Guide/Access Output\|output]] handles most of the basic '''I/O''' for VLC. They are usually '''protocols''' implementations (http, ftp,...) or '''devices''' access (Webcams, Capture cards).

	We will discuss about ''''input access'''' in this page.		We will discuss about ''''input access'''' in this page.

J-b: /* Functions to implement */

2015-05-22T08:13:05Z

Functions to implement

← Older revision		Revision as of 08:13, 22 May 2015
Line 31:		Line 31:
	As you can see {{VLCSourceFile\|name=include/vlc_access.h}}, you should define:		As you can see {{VLCSourceFile\|name=include/vlc_access.h}}, you should define:

	*Seek, as in pf_seek		* Seek, as in pf_seek,
	*Control, as in pf_control		* Control, as in pf_control,
	*Read or Block, depending on your module [[Hacker_Guide/Access#Type\|type]]		* Read or Block, depending on your module [[Hacker_Guide/Access#Type\|type]].

	After implementing those functions, you should assign them to the corresponding pf_ function.		After implementing those functions, you should assign them to the corresponding pf_ function.

J-b: /* Functions to implement */

2015-05-22T08:12:44Z

Functions to implement

← Older revision		Revision as of 08:12, 22 May 2015
Line 33:		Line 33:
	*Seek, as in pf_seek		*Seek, as in pf_seek
	*Control, as in pf_control		*Control, as in pf_control
	*Read or Block, depending on your module [[Hacker_Guide/Access/#Type\|type]]		*Read or Block, depending on your module [[Hacker_Guide/Access#Type\|type]]

	After implementing those functions, you should assign them to the corresponding pf_ function.		After implementing those functions, you should assign them to the corresponding pf_ function.