struct opj_event_mgr * p_manager
);
+/**
+ * Skips the Jpeg2000 Codestream Header box - JP2C Header box.
+ *
+ * @param cio the stream to write data to.
+ * @param jp2 the jpeg2000 file codec.
+ * @param p_manager user event manager.
+ *
+ * @return true if writting was successful.
+*/
+opj_bool jp2_skip_jp2c( opj_jp2_v2_t *jp2,
+ struct opj_stream_private *cio,
+ struct opj_event_mgr * p_manager );
+
/**
* Reads the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
*
/*@}*/
+/**
+ * Sets up the procedures to do on writting header after the codestream.
+ * Developpers wanting to extend the library can add their own writting procedures.
+ */
+static void jp2_setup_end_header_writting (opj_jp2_v2_t *jp2);
+
+
/**
* Sets up the procedures to do on reading header after the codestream.
* Developpers wanting to extend the library can add their own writting procedures.
*/
static const opj_jp2_header_handler_t * jp2_find_handler (int p_id );
+/**
+ * Sets up the validation ,i.e. adds the procedures to lauch to make sure the codec parameters
+ * are valid. Developpers wanting to extend the library can add their own validation procedures.
+ */
+static void jp2_setup_encoding_validation (opj_jp2_v2_t *jp2);
+
+
+/**
+ * Sets up the procedures to do on writting header. Developpers wanting to extend the library can add their own writting procedures.
+ */
+static void jp2_setup_header_writting (opj_jp2_v2_t *jp2);
+
+/**
+ * The default validation procedure without any extension.
+ *
+ * @param jp2 the jpeg2000 codec to validate.
+ * @param cio the input stream to validate.
+ * @param p_manager the user event manager.
+ *
+ * @return true if the parameters are correct.
+ */
+opj_bool jp2_default_validation ( opj_jp2_v2_t * jp2,
+ struct opj_stream_private *cio,
+ struct opj_event_mgr * p_manager );
+
/**
* Finds the image execution function related to the given box id.
*
/* read header from file */
unsigned char l_data_header [8];
- // preconditions
+ /* preconditions */
assert(cio != 00);
assert(box != 00);
assert(p_number_bytes_read != 00);
opj_read_bytes(l_data_header,&(box->length), 4);
opj_read_bytes(l_data_header+4,&(box->type), 4);
- // do we have a "special very large box ?"
- // read then the XLBox
+ /* do we have a "special very large box ?" */
+ /* read then the XLBox */
if (box->length == 1) {
OPJ_UINT32 l_xl_part_size;
opj_event_mgr_t * p_manager
)
{
- // preconditions
+ /* preconditions */
assert(p_image_header_data != 00);
assert(jp2 != 00);
assert(p_manager != 00);
opj_read_bytes(p_image_header_data,&(jp2->bpc),1); /* BPC */
++ p_image_header_data;
- // if equal to 0 then need a BPC box (cf. chapter about image header box of the norm)
+ /* if equal to 0 then need a BPC box (cf. chapter about image header box of the norm) */
/*if (jp2->bpc == 0){
- // indicate with a flag that we will wait a BPC box
+ indicate with a flag that we will wait a BPC box
}*/
opj_read_bytes(p_image_header_data,&(jp2->C),1); /* C */
++ p_image_header_data;
- // Should be equal to 7 cf. chapter about image header box of the norm
+ /* Should be equal to 7 cf. chapter about image header box of the norm */
if (jp2->C != 7){
opj_event_msg_v2(p_manager, EVT_INFO, "JP2 IHDR box: compression type indicate that the file is not a conforming JP2 file (%d) \n", jp2->C);
}
{
OPJ_UINT32 i;
- // preconditions
+ /* preconditions */
assert(p_bpc_header_data != 00);
assert(jp2 != 00);
assert(p_manager != 00);
- // TODO MSD
+ /* TODO MSD */
/*if (jp2->bpc != 0 ){
opj_event_msg_v2(p_manager, EVT_WARNING, "A BPCC header box is available although BPC is different to zero (%d)\n",jp2->bpc);
}*/
- // and length is relevant
+ /* and length is relevant */
if (p_bpc_header_size != jp2->numcomps) {
opj_event_msg_v2(p_manager, EVT_ERROR, "Bad BPCC header box (bad size)\n");
return OPJ_FALSE;
}
- // read info for each component
+ /* read info for each component */
for (i = 0; i < jp2->numcomps; ++i) {
opj_read_bytes(p_bpc_header_data,&jp2->comps[i].bpcc ,1); /* read each BPCC component */
++p_bpc_header_data;
OPJ_UINT16 i, j;
OPJ_UINT32 l_value;
- // preconditions
+ /* preconditions */
assert(p_pclr_header_data != 00);
assert(jp2 != 00);
assert(p_manager != 00);
for(j = 0; j < nr_entries; ++j) {
for(i = 0; i < nr_channels; ++i) {
- //*entries++ = cio_read(cio, channel_size[i]>>3);
+ /**entries++ = cio_read(cio, channel_size[i]>>3); */
opj_read_bytes(p_pclr_header_data, &l_value , channel_size[i]>>3); /* Cji */
p_pclr_header_data += channel_size[i]>>3;
*entries = (OPJ_UINT32) l_value;
OPJ_BYTE i, nr_channels;
OPJ_UINT32 l_value;
- // preconditions
+ /* preconditions */
assert(jp2 != 00);
assert(p_cmap_header_data != 00);
assert(p_manager != 00);
unsigned short i;
OPJ_UINT32 l_value;
- // preconditions
+ /* preconditions */
assert(jp2 != 00);
assert(p_cdef_header_data != 00);
assert(p_manager != 00);
{
OPJ_UINT32 l_value;
- // preconditions
+ /* preconditions */
assert(jp2 != 00);
assert(p_colr_header_data != 00);
assert(p_manager != 00);
opj_read_bytes(p_colr_header_data,&jp2->enumcs ,4); /* EnumCS */
}
else if (jp2->meth == 2) {
- // ICC profile
+ /* ICC profile */
int it_icc_value = 0;
int icc_len = p_colr_header_size - 3;
}
}
- else // TODO MSD
+ else /* TODO MSD */
opj_event_msg_v2(p_manager, EVT_INFO, "COLR BOX meth value is not a regular value (%d), so we will skip the fields following the approx field.\n", jp2->meth);
jp2->color.jp2_has_colr = 1;
*/
opj_bool jp2_end_decompress(opj_jp2_v2_t *jp2, opj_stream_private_t *cio, opj_event_mgr_t * p_manager)
{
- // preconditions
+ /* preconditions */
assert(jp2 != 00);
assert(cio != 00);
assert(p_manager != 00);
return j2k_end_decompress(jp2->j2k, cio, p_manager);
}
+/**
+ * Ends the compression procedures and possibility add data to be read after the
+ * codestream.
+ */
+opj_bool jp2_end_compress( opj_jp2_v2_t *jp2,
+ opj_stream_private_t *cio,
+ opj_event_mgr_t * p_manager)
+{
+ /* preconditions */
+ assert(jp2 != 00);
+ assert(cio != 00);
+ assert(p_manager != 00);
+
+ /* customization of the end encoding */
+ jp2_setup_end_header_writting(jp2);
+
+ if (! j2k_end_compress(jp2->j2k,cio,p_manager)) {
+ return OPJ_FALSE;
+ }
+
+ /* write header */
+ return jp2_exec(jp2,jp2->m_procedure_list,cio,p_manager);
+}
+
+
+/**
+ * Sets up the procedures to do on writing header after the codestream.
+ * Developers wanting to extend the library can add their own writing procedures.
+ */
+void jp2_setup_end_header_writting (opj_jp2_v2_t *jp2)
+{
+ /* preconditions */
+ assert(jp2 != 00);
+
+ opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)jp2_write_jp2c );
+ /* DEVELOPER CORNER, add your custom procedures */
+}
+
/**
* Sets up the procedures to do on reading header after the codestream.
- * Developpers wanting to extend the library can add their own writting procedures.
+ * Developers wanting to extend the library can add their own writing procedures.
*/
void jp2_setup_end_header_reading (opj_jp2_v2_t *jp2)
{
- // preconditions
+ /* preconditions */
assert(jp2 != 00);
- opj_procedure_list_add_procedure(jp2->m_procedure_list,(void*)jp2_read_header_procedure );
+ opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)jp2_read_header_procedure );
/* DEVELOPER CORNER, add your custom procedures */
}
+/**
+ * The default validation procedure without any extension.
+ *
+ * @param jp2 the jpeg2000 codec to validate.
+ * @param cio the input stream to validate.
+ * @param p_manager the user event manager.
+ *
+ * @return true if the parameters are correct.
+ */
+opj_bool jp2_default_validation ( opj_jp2_v2_t * jp2,
+ opj_stream_private_t *cio,
+ opj_event_mgr_t * p_manager )
+{
+ opj_bool l_is_valid = OPJ_TRUE;
+ unsigned int i;
+
+ /* preconditions */
+ assert(jp2 != 00);
+ assert(cio != 00);
+ assert(p_manager != 00);
+
+ /* JPEG2000 codec validation */
+ /*TODO*/
+
+ /* STATE checking */
+ /* make sure the state is at 0 */
+ l_is_valid &= (jp2->jp2_state == JP2_STATE_NONE);
+
+ /* make sure not reading a jp2h ???? WEIRD */
+ l_is_valid &= (jp2->jp2_img_state == JP2_IMG_STATE_NONE);
+
+ /* POINTER validation */
+ /* make sure a j2k codec is present */
+ l_is_valid &= (jp2->j2k != 00);
+
+ /* make sure a procedure list is present */
+ l_is_valid &= (jp2->m_procedure_list != 00);
+
+ /* make sure a validation list is present */
+ l_is_valid &= (jp2->m_validation_list != 00);
+
+ /* PARAMETER VALIDATION */
+ /* number of components */
+ l_is_valid &= (jp2->numcl > 0);
+ /* width */
+ l_is_valid &= (jp2->h > 0);
+ /* height */
+ l_is_valid &= (jp2->w > 0);
+ /* precision */
+ for (i = 0; i < jp2->numcomps; ++i) {
+ l_is_valid &= (jp2->comps[i].bpcc > 0);
+ }
+
+ /* METH */
+ l_is_valid &= ((jp2->meth > 0) && (jp2->meth < 3));
+
+ /* stream validation */
+ /* back and forth is needed */
+ l_is_valid &= opj_stream_has_seek(cio);
+
+ return l_is_valid;
+}
/**
* Reads a jpeg2000 file header structure.
OPJ_UINT32 l_current_data_size;
unsigned char * l_current_data = 00;
- // preconditions
+ /* preconditions */
assert(cio != 00);
assert(jp2 != 00);
assert(p_manager != 00);
memset(l_current_data, 0 , l_last_data_size);
while (jp2_read_boxhdr_v2(&box,&l_nb_bytes_read,cio,p_manager)) {
- // is it the codestream box ?
+ /* is it the codestream box ? */
if (box.type == JP2_JP2C) {
if (jp2->jp2_state & JP2_STATE_HEADER) {
jp2->jp2_state |= JP2_STATE_CODESTREAM;
opj_bool l_result = OPJ_TRUE;
OPJ_UINT32 l_nb_proc, i;
- // preconditions
+ /* preconditions */
assert(p_procedure_list != 00);
assert(jp2 != 00);
assert(cio != 00);
++l_procedure;
}
- // and clear the procedure list at the end.
+ /* and clear the procedure list at the end. */
opj_procedure_list_clear(p_procedure_list);
return l_result;
}
+/**
+ * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
+ *
+ * @param jp2 the jpeg2000 file codec.
+ * @param cio the stream object.
+ *
+ * @return true if the codec is valid.
+ */
+opj_bool jp2_start_compress(opj_jp2_v2_t *jp2,
+ struct opj_stream_private *cio,
+ opj_image_t * p_image,
+ struct opj_event_mgr * p_manager)
+{
+ /* preconditions */
+ assert(jp2 != 00);
+ assert(cio != 00);
+ assert(p_manager != 00);
+
+ /* customization of the validation */
+ jp2_setup_encoding_validation (jp2);
+
+ /* validation of the parameters codec */
+ if (! jp2_exec(jp2,jp2->m_validation_list,cio,p_manager)) {
+ return OPJ_FALSE;
+ }
+
+ /* customization of the encoding */
+ jp2_setup_header_writting(jp2);
+
+ /* write header */
+ if (! jp2_exec (jp2,jp2->m_procedure_list,cio,p_manager)) {
+ return OPJ_FALSE;
+ }
+
+ return j2k_start_compress(jp2->j2k,cio,p_image,p_manager);
+}
/**
* Finds the execution function related to the given box id.
{
unsigned int l_magic_number;
- // preconditions
+ /* preconditions */
assert(p_header_data != 00);
assert(jp2 != 00);
assert(p_manager != 00);
return OPJ_FALSE;
}
- // rearrange data
+ /* rearrange data */
opj_read_bytes(p_header_data,&l_magic_number,4);
if (l_magic_number != 0x0d0a870a ) {
opj_event_msg_v2(p_manager, EVT_ERROR, "Error with JP Signature : bad magic number\n");
{
OPJ_UINT32 i, l_remaining_bytes;
- // preconditions
+ /* preconditions */
assert(p_header_data != 00);
assert(jp2 != 00);
assert(p_manager != 00);
return OPJ_TRUE;
}
+/**
+ * Skips the Jpeg2000 Codestream Header box - JP2C Header box.
+ *
+ * @param cio the stream to write data to.
+ * @param jp2 the jpeg2000 file codec.
+ * @param p_manager user event manager.
+ *
+ * @return true if writting was successful.
+*/
+opj_bool jp2_skip_jp2c( opj_jp2_v2_t *jp2,
+ struct opj_stream_private *cio,
+ struct opj_event_mgr * p_manager )
+{
+ /* preconditions */
+ assert(jp2 != 00);
+ assert(cio != 00);
+ assert(p_manager != 00);
+
+ jp2->j2k_codestream_offset = opj_stream_tell(cio);
+
+ if (opj_stream_skip(cio,8,p_manager) != 8) {
+ return OPJ_FALSE;
+ }
+
+ return OPJ_TRUE;
+}
/**
* Reads the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
opj_jp2_box_t box;
const opj_jp2_header_handler_t * l_current_handler;
- // preconditions
+ /* preconditions */
assert(p_header_data != 00);
assert(jp2 != 00);
assert(p_manager != 00);
{
OPJ_UINT32 l_value;
- // preconditions
+ /* preconditions */
assert(p_data != 00);
assert(box != 00);
assert(p_number_bytes_read != 00);
*p_number_bytes_read = 8;
- // do we have a "special very large box ?"
- // read then the XLBox
+ /* do we have a "special very large box ?" */
+ /* read then the XLBox */
if (box->length == 1) {
unsigned int l_xl_part_size;
p_manager);
}
+/**
+ * Sets up the validation ,i.e. adds the procedures to launch to make sure the codec parameters
+ * are valid. Developers wanting to extend the library can add their own validation procedures.
+ */
+void jp2_setup_encoding_validation (opj_jp2_v2_t *jp2)
+{
+ /* preconditions */
+ assert(jp2 != 00);
+
+ opj_procedure_list_add_procedure(jp2->m_validation_list, (opj_procedure)jp2_default_validation);
+ /* DEVELOPER CORNER, add your custom validation procedure */
+}
+
/**
* Sets up the validation ,i.e. adds the procedures to lauch to make sure the codec parameters
* are valid. Developpers wanting to extend the library can add their own validation procedures.
*/
void jp2_setup_decoding_validation (opj_jp2_v2_t *jp2)
{
- // preconditions
+ /* preconditions */
assert(jp2 != 00);
/* DEVELOPER CORNER, add your custom validation procedure */
}
+/**
+ * Sets up the procedures to do on writting header.
+ * Developers wanting to extend the library can add their own writing procedures.
+ */
+void jp2_setup_header_writting (opj_jp2_v2_t *jp2)
+{
+ /* preconditions */
+ assert(jp2 != 00);
+
+ opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)jp2_write_jp );
+ opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)jp2_write_ftyp );
+ opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)jp2_write_jp2h );
+ opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)jp2_skip_jp2c );
+
+ /* DEVELOPER CORNER, insert your custom procedures */
+
+}
+
/**
* Sets up the procedures to do on reading header.
* Developpers wanting to extend the library can add their own writting procedures.
*/
void jp2_setup_header_reading (opj_jp2_v2_t *jp2)
{
- // preconditions
+ /* preconditions */
assert(jp2 != 00);
- opj_procedure_list_add_procedure(jp2->m_procedure_list,(void*)jp2_read_header_procedure );
+ opj_procedure_list_add_procedure(jp2->m_procedure_list,(opj_procedure)jp2_read_header_procedure );
/* DEVELOPER CORNER, add your custom procedures */
}
p_manager);
}
+/**
+ * Writes a tile.
+ * @param p_j2k the jpeg2000 codec.
+ * @param p_stream the stream to write data to.
+ * @param p_manager the user event manager.
+ */
+opj_bool jp2_write_tile ( opj_jp2_v2_t *p_jp2,
+ OPJ_UINT32 p_tile_index,
+ OPJ_BYTE * p_data,
+ OPJ_UINT32 p_data_size,
+ struct opj_stream_private *p_stream,
+ struct opj_event_mgr * p_manager )
+{
+ return j2k_write_tile (p_jp2->j2k,p_tile_index,p_data,p_data_size,p_stream,p_manager);
+}
+
/**
* Decode tile data.
* @param p_j2k the jpeg2000 codec.
jp2->color.jp2_pclr = NULL;
jp2->color.jp2_has_colr = 0;
- // validation list creation
+ /* validation list creation */
jp2->m_validation_list = opj_procedure_list_create();
if (! jp2->m_validation_list) {
jp2_destroy(jp2);
return 00;
}
- // execution list creation
+ /* execution list creation */
jp2->m_procedure_list = opj_procedure_list_create();
if (! jp2->m_procedure_list) {
jp2_destroy(jp2);
projects / openjpeg.git / blobdiff