1 /*

     2 * Copyright (c) 2003-2006 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Camera Application Engine still image queue for extension processing

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef CAEIMAGEQUEUEEXTPRO_H

    21 #define CAEIMAGEQUEUEEXTPRO_H

    22 

    23 

    24 // FORWARD DECLARATIONS

    25 class HBufC8;

    26 class CFbsBitmap;

    27 class CCaeImageItemExtPro;

    28 template <class T> class RPointerArray;

    29 

    30 // CLASS DECLARATION

    31 

    32 /**

    33 * Camera Application Engine still image queue for extension processing class.

    34 *

    35 */

    36 

    37 NONSHARABLE_CLASS( CCaeImageQueueExtPro ) : public CBase

    38     {

    39 

    40     public: // Construction and destruction

    41 

    42         /**

    43         * Two-phased constructor.

    44         */

    45         static CCaeImageQueueExtPro* NewL();

    46 

    47         /**

    48         * Destructor.

    49         */

    50         virtual ~CCaeImageQueueExtPro();

    51 

    52     public:

    53 

    54         /**

    55         * Appends an image item into the image queue.

    56         * @since 3.2

    57         * @param aBitmap Symbian OS bitmap snap image or captured bitmap image.

    58         * @param aImageData Other than Symbian OS bitmap image.

    59         * @param aLastImage Set when last image of the burst is completed.

    60         * @param aSnapImage Set when aBitmap is snap image.

    61         * @return Error code KErrNone, if the insertion is successful, 

    62         * otherwise one of the system wide error codes.

    63         */

    64         TInt AppendImage( 

    65             CFbsBitmap* aBitmap, 

    66             HBufC8*     aImageData,

    67             TBool       aLastImage,

    68             TBool       aSnapImage );

    69 

    70         /**

    71         * Gets the count of image items in the image queue.

    72         * @since 3.2

    73         * @return The count of image items in the image queue

    74         */

    75         TInt ImageCount() const;

    76             

    77         /**

    78         * Gets the next image from image queue.

    79         * @since 3.2

    80         * @param aBitmap Symbian OS bitmap image.

    81         * @param aImageData Other than Symbian OS bitmap image.

    82         * @param aLastImage Set when last image of the burst is completed.

    83         * @param aSnapImage Set when aBitmap is snap image.

    84         * @return Error code KErrNone, if the operation is successful, 

    85         * otherwise KErrUnderflow (= no images in the queue).

    86         */

    87         TInt GetNextImage( 

    88             CFbsBitmap*& aBitmap, 

    89             HBufC8*&     aImageData,

    90             TBool&       aLastImage,

    91             TBool&       aSnapImage );

    92 

    93         /**

    94         * Resets and destroys image items from the image queue.

    95         * @since 3.2

    96         * @return void

    97         */

    98         void ResetAndDestroyImages();

    99 

   100     private: // Private member methods

   101 

   102         /**

   103         * C++ constructor.

   104         */

   105         CCaeImageQueueExtPro();

   106 

   107         /**

   108         * Symbian OS 2nd phase constructor that can leave.

   109         */

   110         void ConstructL();

   111 

   112     private: // Data

   113 

   114         // Image queue for the images captured in burst.

   115         RPointerArray<CCaeImageItemExtPro>* iImageQueue;

   116 

   117     };

   118 

   119 

   120 #endif // CAEIMAGEQUEUEEXTPRO_H