2008-03-24 01:10:09 +01:00
// Copyright (c) 2007-2008, Niels Martin Hansen
2007-08-22 22:58:53 +02:00
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
2009-07-29 07:43:02 +02:00
// Aegisub Project http://www.aegisub.org/
/// @file audio_provider_pcm.h
/// @see audio_provider_pcm.cpp
/// @ingroup audio_input
///
2007-08-22 22:58:53 +02:00
2009-09-11 04:36:34 +02:00
# include <vector>
2010-12-11 17:47:03 +01:00
# ifdef _WIN32
2012-10-29 23:02:41 +01:00
# define WIN32_LEAN_AND_MEAN
2008-03-24 01:10:09 +01:00
# include <windows.h>
# endif
2009-09-11 04:36:34 +02:00
# include "include/aegisub/audio_provider.h"
2007-08-22 22:58:53 +02:00
2012-02-20 19:22:12 +01:00
# include <libaegisub/scoped_ptr.h>
2007-08-22 22:58:53 +02:00
class PCMAudioProvider : public AudioProvider {
2013-12-12 01:29:48 +01:00
mutable void * current_mapping = nullptr ;
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
2012-10-15 06:37:14 +02:00
# ifdef _WIN32
2013-12-12 01:29:48 +01:00
mutable int64_t mapping_start = 0 ;
mutable size_t mapping_length = 0 ;
2012-10-15 06:37:14 +02:00
agi : : scoped_holder < HANDLE , BOOL ( __stdcall * ) ( HANDLE ) > file_handle ;
agi : : scoped_holder < HANDLE , BOOL ( __stdcall * ) ( HANDLE ) > file_mapping ;
2008-03-24 01:10:09 +01:00
# else
2013-12-12 01:29:48 +01:00
mutable off_t mapping_start = 0 ;
mutable size_t mapping_length = 0 ;
2012-10-15 06:37:14 +02:00
agi : : scoped_holder < int , int ( * ) ( int ) > file_handle ;
2008-03-24 01:10:09 +01:00
# endif
2007-08-22 22:58:53 +02:00
protected :
2013-01-04 16:01:50 +01:00
PCMAudioProvider ( agi : : fs : : path const & filename ) ; // Create base object and open the file mapping
2008-03-24 01:10:09 +01:00
virtual ~ PCMAudioProvider ( ) ; // Closes the file mapping
2010-12-08 04:36:10 +01:00
char * EnsureRangeAccessible ( int64_t range_start , int64_t range_length ) const ; // Ensure that the given range of bytes are accessible in the file mapping and return a pointer to the first byte of the requested range
2008-03-24 01:10:09 +01:00
2012-08-18 05:13:44 +02:00
/// Size of the opened file
2013-12-12 01:29:48 +01:00
int64_t file_size = 0 ;
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
2007-08-22 22:58:53 +02:00
struct IndexPoint {
2007-08-31 16:11:35 +02:00
int64_t start_byte ;
int64_t start_sample ;
int64_t num_samples ;
2007-08-22 22:58:53 +02:00
} ;
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
2007-08-22 22:58:53 +02:00
typedef std : : vector < IndexPoint > IndexVector ;
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
2007-08-22 22:58:53 +02:00
IndexVector index_points ;
2013-11-21 18:13:36 +01:00
void FillBuffer ( void * buf , int64_t start , int64_t count ) const override ;
2007-08-22 22:58:53 +02:00
} ;
// Construct the right PCM audio provider (if any) for the file
2013-06-08 06:19:40 +02:00
std : : unique_ptr < AudioProvider > CreatePCMAudioProvider ( agi : : fs : : path const & filename ) ;